search

CS3219-AY2425S1 / cs3219-ay2425s1-project-g20

nus-cs3219-ay2425s1-cs3219-ay2425s1-project-project-template created by GitHub Classroom
MIT License
2 stars 1 forks source link

Standardise which env files are committed #44

Open Cloud7050 opened 1 week ago

Cloud7050 commented 1 week ago

Frontend currently has an env file that is committed. The design seems inverted for our two services, where they should not be committed. There may be room to discuss a more optimal design.

Cloud7050 commented 4 days ago

I propose ignoring the frontend's env file like the others, and deleting it from the repo. The frontend's readme is also a bit outdated.

Also noticed frontend/vite.config.ts.timestamp-1728241837061-0529f25c7e304.mjs is currently checked in, seems to be a temporary compiled file that is usually deleted automatically, we may be able to just delete this too to clean up.

Cloud7050 commented 4 days ago

dockerignore has some duplicates and could be cleaned up too

Cloud7050 commented 4 days ago

Sample JWT secret is checked in, there may be risk of staging the locally modified file.

Seems to be duplicated currently? In both env file and the txt file.

Cloud7050 commented 4 days ago

Vite's design seems to want .env.development to be checked in. So far, we do not need a .env.development.local, which is the one that's ignored.

https://v2.vitejs.dev/guide/env-and-mode.html#env-files

I think we can model our services based on the Vite design, and just check those in too since we don't have any secrets in them and just seem to stick with the defaults in the example file.