Skip to content

Commit d18429c

Browse files
committed
docs: update README for improved deployment instructions and environment variable setup
1 parent 8cae9e9 commit d18429c

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,39 +17,47 @@ Tech stack:
1717
- Install Docker
1818
- Install Docker Compose plugin
1919

20-
2. Open project directory
20+
2. Clone repository
21+
```bash
22+
git clone https://github.com/Atuldubey98/OptimumERP.git
23+
```
24+
25+
3. Open project directory
2126
```bash
2227
cd OptimumERP
2328
```
2429

25-
3. Create environment file
30+
4. Create environment file
2631
- Create .env in project root.
2732
- Use env.txt as reference.
28-
- Set required values for:
29-
- MONGO_URI
30-
- SESSION_SECRET
31-
- NODE_MAILER_USER_NAME
32-
- NODE_MAILER_APP_PASSWORD
33-
- NODE_MAILER_HOST
34-
- VITE_APP_URL
35-
- VITE_API_URL
36-
37-
4. Start all services
33+
- Add only these keys in .env:
34+
35+
```dotenv
36+
MONGO_URI=mongodb://mongo:27017/mernapp?replicaSet=rs0
37+
SESSION_SECRET=SESSION_SECRET
38+
VITE_API_URL=http://localhost:3000
39+
IMPORT_CRON_SCHEDULE=*/5 * * * *
40+
LOG_FILE_PATH=./logs/app.log
41+
DEFAULT_USER_PLAN=platinum
42+
NETWORK_STORAGE_PATH=./uploads
43+
```
44+
45+
5. Start all services
3846
```bash
3947
docker compose up -d --build
4048
```
4149

42-
5. Verify services
50+
6. Verify services
4351
```bash
4452
docker compose ps
4553
```
4654

47-
6. Verify backend health
55+
7. Verify backend health
4856
```bash
4957
curl http://localhost:3000/api/v1/health
5058
```
5159

52-
7. Access application
60+
8. Access application
5361
- Frontend: http://localhost:5173
5462
- Backend API: http://localhost:3000/api/v1
5563

0 commit comments

Comments
 (0)