Skip to content

Commit 9956831

Browse files
committed
.env updates
1 parent 3bb1483 commit 9956831

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

instructions.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,14 @@ We will use a Python-centric web application technology stack, consisting of:
1010
- A Python back-end using [flask](https://flask.palletsprojects.com/en/2.2.x/)
1111
- A MongoDB database connected to the Python back-end using [pymongo](https://pymongo.readthedocs.io/en/stable/)
1212

13-
Credentials for connecting to the database must be stored in a [.env](https://knowledge.kitchen/content/courses/software-engineering/slides/flask-pymongo/#combined) file and not included in version control and shared among teammates (and admins/managers) using the team's messenger system. Use the [`dotenv`](https://pypi.org/project/python-dotenv/) or similar module to retrieve values from this file within code.
13+
Credentials for connecting to the database must be stored in a [.env](https://knowledge.kitchen/content/courses/software-engineering/slides/flask-pymongo/#combined) file.
1414

15-
If your application requires user authentication, we recommend using the [`flask-login`](https://pypi.org/project/Flask-Login/) module, which makes it relatively simple to implement user accounts.
15+
- This file must not be included in version control, since it contains sensitive private data.
16+
- Share this file among teammates (and admins/managers) using the team's messenger system.
17+
- Use the [`dotenv`](https://pypi.org/project/python-dotenv/) or similar module to retrieve values from this file within code.
18+
- Include an `env.example` file in the repository that shows the format of the `.env` file that should be created, but includes only dummy data instead of the real values for each environmental variable.
19+
20+
If your application requires user authentication, use the [`flask-login`](https://pypi.org/project/Flask-Login/) module, which makes it relatively simple to implement user accounts.
1621

1722
## Design
1823

0 commit comments

Comments
 (0)