Skip to content

Commit c41c741

Browse files
committed
feat(docs): update README with new environment variables and default values for improved setup instructions
1 parent c78dc8b commit c41c741

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,15 @@ go mod download
3535

3636
### المتغيرات البيئية | Environment Variables
3737
```bash
38-
MONGO_URI=
39-
MONGO_DATABASE=
40-
PORT=
38+
cp .env.example .env
39+
API_VERSION=1.0.0
40+
ENVIRONMENT=development
41+
PORT=3000
42+
APP_NAME="Naqa API"
43+
APP_DESCRIPTION="Naqa API is a RESTful service designed to provide data on the purification process of Saudi stocks."
44+
MONGO_URI="mongodb://mongodb:27017"
45+
MONGO_DATABASE="naqa"
46+
SEED_DATA="false"
4147
```
4248

4349
### التصنيف الشرعي | Shariah Classification

0 commit comments

Comments
 (0)