Skip to content

Commit 552fdd7

Browse files
committed
Merge branch 'main' of github.com:Codebugged-Research/next-steps-cv-builder
2 parents 0693885 + c7d752a commit 552fdd7

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

backend/Readme.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Next Steps CV Builder - Backend API
2+
3+
This backend provides RESTful APIs for user management and CV creation, built with Express.js and MongoDB.
4+
5+
## Base URL
6+
7+
```
8+
{will be updated}
9+
```
10+
11+
## Endpoints
12+
13+
### User APIs (`/api/users`)
14+
15+
- `POST /api/users/register`
16+
Register a new user.
17+
**Body:** `{ fullName, email, password, ... }`
18+
19+
- `POST /api/users/login`
20+
Authenticate user and return a token.
21+
**Body:** `{ email, password }`
22+
23+
- `GET /api/users/profile`
24+
Get logged-in user's profile.
25+
**Auth required**
26+
27+
### CV APIs (`/api/cv`)
28+
29+
- `POST /api/cv/save`
30+
Save or update user's CV.
31+
**Body:** `CV data object`
32+
33+
- `GET /api/cv/:userId`
34+
Get CV for a specific user.
35+
36+
- `POST /api/cv/upload`
37+
Upload CV file (PDF, DOC, DOCX).
38+
**Form Data:** `file`
39+
40+
## File Uploads
41+
42+
- Uses [Multer](https://github.com/expressjs/multer) for file uploads.
43+
- Supports GridFS for storing files in MongoDB.
44+
45+
## Setup
46+
47+
1. Clone the repo.
48+
2. Install dependencies:
49+
```bash
50+
npm install
51+
```
52+
3. Set environment variables in `.env` (see `.env.example`).
53+
4. Start the server:
54+
```bash
55+
npm start
56+
```
57+
58+
## License
59+
60+
MIT

0 commit comments

Comments
 (0)