Skip to content

Commit 6af1bcb

Browse files
docs: add environment variable documentation
1 parent 4ae0ef6 commit 6af1bcb

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

.env.example

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
PORT=5000
2+
3+
MONGO_URI=your_mongodb_connection_string
4+
5+
SESSION_SECRET=your_session_secret
6+
7+
NODE_ENV=development
8+
9+
LOG_LEVEL=debug

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,27 @@ Install all required dependencies:
8080
npm install
8181
npm install --save-dev jasmine @types/jasmine supertest express-session passport passport-local bcryptjs
8282
```
83+
## Environment Variables
84+
85+
Create a `.env` file in the project root and add the following variables:
86+
87+
| Variable | Description |
88+
|----------|-------------|
89+
| PORT | Port on which the backend server runs |
90+
| MONGO_URI | MongoDB connection string |
91+
| SESSION_SECRET | Secret key used for session management |
92+
| NODE_ENV | Application environment |
93+
| LOG_LEVEL | Logging level |
94+
95+
### Example
96+
97+
```env
98+
PORT=5000
99+
MONGO_URI=your_mongodb_connection_string
100+
SESSION_SECRET=your_session_secret
101+
NODE_ENV=development
102+
LOG_LEVEL=debug
103+
```
83104

84105
### Running the Tests
85106
1. **Start MongoDB** (if not already running):

0 commit comments

Comments
 (0)