Chore/setup env - Githubissues

Andres2D commented 2 months ago

Description

This pull request contains the basic configuration to start using environment variables (dotenv) in the project. Environment variables will store all the static data we may use in the codebase. More info is in the official documentation

Closes #48

What change does this PR introduce?

Introducing environment variables means that every developer must have their own .env.(untracked) file. In which, you can play with the values of the different variables. Moreover, this PR introduces a .env.example file, which we must update (with a dummy value) anytime a new environment variable is introduced. The idea of this example file is to show the existing variables; we shouldn't show real values in this file.

Please select the relevant option(s).

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Documentation update (changes to docs/code comments)

What is the proposed approach?

Using environment values.

Checklist:

[x] The commit message follows our adopted guidelines
[x] Testing has been done for the change(s) added (for bug fixes/features)
[ ] Relevant comments/docs have been added/updated (for bug fixes/features)

Note

When this code go to production. The server must have the environment variables defined in order to work properly. The .env file is just for dev environment.

tjtanjin commented 2 months ago

LGTM, did a small change to include the actual env value. Thanks!

Andres2D commented 2 months ago

Well, actually the .env file shouldn't be tracked by git. Maybe in the future you will store secrets or confidential data on those variables. However, when the time comes you can untrack this file anyway.