Merge pull request #100 from gfa-cc-after/chore/add-dotenv-for-secrets

chore: add dotenv file to store secrets
gfa-cc-after · Sep 7, 2024 · 18869e0 · 18869e0
2 parents 5bd2fe9 + 6ad9ba9
commit 18869e0
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/.env.sample b/.env.sample
@@ -0,0 +1,2 @@
+MAIL_PASSWORD=
+MAIL_USERNAME=
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ data
 *.idea
 
 .DS_Store
+.env
diff --git a/README.md b/README.md
@@ -6,3 +6,16 @@
 
 You can find the frontend of the project in the `frontend` folder
 [here](./frontend/README.md).
+
+
+## Environemnts and secrets
+
+The project uses a `.env` file to store the secrets and environment variables. You can find an example of the file in the `.env.example` file. The dotenv file is used to store the secrets and environment variables for the docker-compose file.
+
+You can copy the sample file to a new file called `.env` and fill in the values.
+
+```bash
+cp .env.sample .env
+```
+
+then fill in the values in the `.env` file.