Use of .env.local instead of .env for local development

uncharted-aske / HMI

Apache License 2.0

1 stars 0 forks source link

Use of .env.local instead of .env for local development #185

Closed YohannParis closed 3 years ago

YohannParis commented 3 years ago

Why

The current .env has to be carefully ignored between each branch, which is prone to error.

What

the .gitignore already include .env.local
updated esbuild.js to select .env.local instead of .env if the --dev argument is used.
this is a braking change, and people need to use .env.local for development.

Testing

Copy the confluence environment variables into .env.local and revert .env to the main branch version. The app should load as usual.

adamocarolli commented 3 years ago

I'll add @mj3cheun here as he previously ran into issues with test cases not working using this approach. I think the dev build flag should prevent this. But adding Manfred to confirm.

mj3cheun commented 3 years ago

Tests have been disabled so 😈

But even if it hasn't this is a really good idea, the .env with blank values fools the tests into thinking the env variables are there, but the real values are in .env.local which can be blocked by .gitignore without issue. Solves the problem completely. Thanks!

mj3cheun commented 3 years ago

Just confirmed that the env variables are being pulled from the .env.local which is great. Only thing i would add is that the README and possibly the confluence should be updated with the new procedure.

YohannParis commented 3 years ago

Just confirmed that the env variables are being pulled from the .env.local which is great. Only thing i would add is that the README and possibly the confluence should be updated with the new procedure.

Thanks @mj3cheun, I also update the confluence page: https://confluence.uncharted.software/display/ASKE/Configurations