Skip to content

Commit e7926ec

Browse files
Update README.md
1 parent c7ca63c commit e7926ec

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

backend/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,15 @@ This backend application template consists of:
4949

5050
---
5151

52+
## SSHhhhttt 🤫 It's a Secret!
53+
54+
All secret variables are configured in the `.env`, but in this case since it is listed in our `.gitignore` you should create one and save it in the root directory.
55+
56+
The secret variables are accessed by 2 different files:
57+
58+
1. `backend7src/config/settings/base.py` $\rightarrow$ The `BackendBaseSettings` class contains all the secret variables. This allows us to set the values dynamically through out the backend application ("dynamic" because we only need to change the value in `.env` file without breaking any code).
59+
2. `docker-compose.yaml` $\rightarrow$ When we initialize the `backend_app` container, we register all the secret variables as well for our containerized backend application.
60+
5261
## Database
5362

5463
**INFO**: No postgres server, no connection!
@@ -132,7 +141,7 @@ Check the `pyproject.toml` as the main configuration file for the following pack
132141

133142
**INFO**: For running the test, make sure you are in the root directory and NOT in the `backend/` directory!
134143

135-
**INFO**: The testing report is automatically generated and saved in ``
144+
**INFO**: The testing report is automatically generated and saved in `backend/coverage/**`
136145

137146
* Step 1: Run PyTest:
138147

0 commit comments

Comments
 (0)