Skip to content

docs: add environment variables documentation and example file for backend setup #711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
firoziya wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add environment variables documentation and example file for backend setup #711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c6e24a9
Create .env.example
firoziya Jun 4, 2026
66bcc3e
Update README.md
firoziya Jun 4, 2026
fc67e0e
Update README.md
firoziya Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,19 @@ $ npm i
$ npm start
```

## 🔐 Environment Variables

Create a `.env` file inside the `backend/` directory with the following variables:

| Variable | Description | Default |
|----------|-------------|---------|
| `MONGO_URI` | MongoDB connection string | `mongodb://127.0.0.1:27017/github_tracker` |
| `SESSION_SECRET` | Secret key for session encryption | (required) |
| `PORT` | Backend server port | `5000` |
| `LOG_LEVEL` | Winston logging level | `debug` (dev) / `info` (prod) |

> **Note**: Copy `backend/.env.example` to `backend/.env` and update the values as needed.

## 🧪 Backend Unit & Integration Testing with Jasmine

This project uses the Jasmine framework for backend unit and integration tests. The tests cover:
Expand Down
13 changes: 13 additions & 0 deletions backend/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Backend Environment Variables

# MongoDB Connection URI (required)
MONGO_URI=mongodb://127.0.0.1:27017/github_tracker

# Session Secret for express-session (required - use a strong random string)
SESSION_SECRET=your_super_secret_key_change_this_in_production

# Server Port (optional, defaults to 5000)
PORT=5000

# Log Level (optional: debug, info, warn, error)
LOG_LEVEL=debug
Loading