CorrelAid / engage-2

MIT License
0 stars 0 forks source link

Make the project ready to be a public repo #12

Closed KonradUdoHannes closed 10 months ago

KonradUdoHannes commented 11 months ago

I think we should check for sensitive data in the repository. In particular we should check whether any of the mocked data for the frontend is sensitive.

If anything sensitive is found we need to remove it and probably squash a bunch of commits, so the sooner this happens (or at least gets checked) the better.

KonradUdoHannes commented 10 months ago

I looked through the repo wrt. sensitive data and I didn't find any major issues.

On the frontend side the we have mock data that is at least partially real, which is a potential issue. But I think its fine for the following reasons.

I bundled the mock Data on the frontend side into a separate module to make it easier to modify, review and remove. See #15. We can still remove the names of the correlaid members and replace them with something artificial, but I don't think its necessary to remove them from the commit history.

On the backend side I did not find any sensitive data as long as we make sure that the following environment variables are only used for local testing and not in any real deployment

This should be fine given the docker compose env variable precedence according to which shell level env vars still overwrite what is in the docker compose file. The only thing this currently rules out, is the use of docker compose's --env-file cli option or env_file configuration file property, as these have lower precedence. As long as this is not needed, no change is required.

KonradUdoHannes commented 10 months ago

An independent ToDo related to this issue is the licence we want to put when making the repository public. I usually default to MIT for open source projects, but I'm open to discuss alternatives to make sure we agree on this. @jandix @DatenBergwerker, what do you think?

jandix commented 10 months ago

@KonradUdoHannes @DatenBergwerker can we close this issue?

KonradUdoHannes commented 10 months ago

@jandix yes, since the repo is already public it was hopefully also ready for that 😂