Skip to content

Commit b0986dc

Browse files
feat: Update Node.js version in CI, refine project structure and setup instructions, and add detailed documentation.
1 parent 2f7a2c3 commit b0986dc

2 files changed

Lines changed: 30 additions & 14 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ jobs:
5353
- name: Set up Node.js
5454
uses: actions/setup-node@v3
5555
with:
56-
node-version: "18"
56+
node-version: "24"
5757
cache: "npm"
5858
cache-dependency-path: frontend/package-lock.json
5959

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,15 @@ backend/
3030
│ ├── db/
3131
│ │ └── mongodb.py
3232
│ ├── utils/
33-
│ │ ├── logger.py
34-
│ │ └── role_checker.py
33+
│ │ └── logger.py
3534
│ └── Scalability_Guide.md
35+
├── Dockerfile
3636
├── requirements.txt
3737
└── README.md
38+
docs/
39+
├── Back-End.md
40+
├── Front-End.md
41+
└── DB_Schema.md
3842
frontend/
3943
├── src/
4044
│ ├── api/
@@ -45,7 +49,12 @@ frontend/
4549
│ └── main.tsx
4650
├── package.json
4751
├── vite.config.ts
52+
├── Dockerfile
4853
└── README.md
54+
.github/
55+
└── workflows/
56+
└── ci.yml
57+
docker-compose.yml
4958
```
5059

5160
---
@@ -101,7 +110,7 @@ Authorization: Bearer <token>
101110
### Health Check APIs
102111
| Method | Endpoint | Description |
103112
|--------|------------------------|------------------|
104-
| GET | /health | Health check |
113+
| GET | /api/v1/health | Health check |
105114

106115
### Auth APIs
107116
| Method | Endpoint | Description |
@@ -170,13 +179,14 @@ A Postman collection is also provided for API testing.
170179

171180
### Backend Setup
172181
```bash
173-
git clone <repo-url>
182+
git clone https://github.com/HackyCoder0951/authdb.git
183+
python -m venv .venv
174184
cd backend
175-
python -m venv venv
176-
source venv/bin/activate
185+
source .venv/bin/activate
177186
pip install -r requirements.txt
178187
# Ensure MongoDB is running locally or set MONGO_URI in .env
179-
uvicorn app.main:app --reload
188+
uvicorn app.main:app --host 0.0.0.0 --port 8001
189+
180190
```
181191

182192
### Frontend Setup
@@ -205,7 +215,17 @@ npm run dev
205215
- **Advanced Logging**: Custom logging utility for better observability.
206216
- Docker containerization
207217
- API rate limiting
208-
- CI/CD pipeline integration
218+
## Detailed Documentation
219+
For deep dives into specific areas, please refer to the `docs/` directory:
220+
- **[Backend Architecture](docs/Back-End.md)**: Logic flow, Auth, and Task management.
221+
- **[Frontend Architecture](docs/Front-End.md)**: Component structure and State management.
222+
- **[Database Schema](docs/DB_Schema.md)**: ERD diagrams and Collection details.
223+
224+
## CI/CD Pipeline
225+
Automated testing and build pipelines are implemented using **GitHub Actions**.
226+
- **Config**: `.github/workflows/ci.yml`
227+
- **Backend**: Runs unit tests and verifies API health.
228+
- **Frontend**: Installs dependencies and checks build status.
209229

210230
---
211231

@@ -219,8 +239,4 @@ npm run dev
219239

220240
---
221241

222-
## Author
223-
Backend Developer Intern Assignment
224-
225-
Built using Python & FastAPI
226-
242+
# *Built using Python & FastAPI*

0 commit comments

Comments
 (0)