https://github.com/datvt243/nodejs-resume-api-ts

Learning Node.js Express, Project create resume API
https://github.com/datvt243/nodejs-resume-api-ts

api crud-application express joi-validation mongoose nodejs router typescript

Last synced: about 2 months ago
JSON representation

Learning Node.js Express, Project create resume API

• Host: GitHub
• URL: https://github.com/datvt243/nodejs-resume-api-ts
• Owner: datvt243
• Created: 2024-08-06T11:39:42.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2026-04-04T11:30:51.000Z (about 2 months ago)
• Last Synced: 2026-04-04T11:35:29.788Z (about 2 months ago)
• Topics: api, crud-application, express, joi-validation, mongoose, nodejs, router, typescript
• Language: TypeScript
• Homepage: https://datvt243.github.io/vue-resume-web/
• Size: 998 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 📄 Resume API - Backend (Updated)

Một ứng dụng API backend **hoàn chỉnh** để **quản lý hồ sơ ứng viên (CV/Resume)** với **Redis rate limiting**, **token blacklist**, **PDF export**, **Winston logging**, và **Jest testing**.

**Version**: 1.0.0 | **Author**: DatVT | **License**: ISC

---

## 🎯 Features

- 🔐 **Authentication**: JWT (access/refresh), Bcrypt, Token Blacklist (Redis)

- 👤 **Profile**: Candidate info + General (skills, languages, career)

- 📚 **Education** / 💼 **Experience** / 🏆 **Awards** / 📜 **Certificates** / 🚀 **Projects** / 👥 **References**

- 📄 **PDF Export** (Pug + PDFKit/Puppeteer)

- 🛡️ **Rate Limiting** (Redis/mem fallback)

- 📊 **Logging** (Winston daily)

- 🧪 **Tests** (Jest: auth/middlewares/utils/DB)

- ✅ **Health**: `/health` endpoint

## 🛠️ Tech Stack

### Core

| Category  | Tech             |

| --------- | ---------------- |

| Runtime   | Node.js          |

| Framework | Express 4.19.2   |

| Language  | TypeScript 5.5.4 |

### Database & Cache

| Tech               | Version | Purpose                |

| ------------------ | ------- | ---------------------- |

| MongoDB + Mongoose | 8.4.0   | Data                   |

| Redis              | 4.6.0   | Rate limit / Blacklist |

### Auth & Security

| Tech               | Version | Purpose    |

| ------------------ | ------- | ---------- |

| JWT                | 9.0.2   | Tokens     |

| Bcrypt             | 5.1.1   | Passwords  |

| express-rate-limit | 8.3.0   | Protection |

### Utils

| Tech                 | Version        | Purpose    |

| -------------------- | -------------- | ---------- |

| Joi                  | 17.13.1        | Validation |

| PDFKit/Puppeteer/Pug | 0.15/22.13/3.0 | PDF        |

| Winston              | 3.19.0         | Logging    |

---

## 📁 Project Structure

```

backend/

├── src/

│   ├── server.ts (health/Redis)

│   ├── config/     (env/Joi/CORS)

│   ├── database/   (Mongo)

│   ├── middlewares/ (rateLimit/logger)

│   ├── models/     (schemas)

│   ├── routers/api/v1/ (CRUD routes)

│   ├── candidate_profile/ (controllers/services per section)

│   ├── services/   (PDF/Redis)

│   ├── utils/      (JWT/bcrypt/blacklist)

│   ├── views/      (Pug)

│   ├── public/     (assets/pdf)

│   ├── __tests__/  (Jest)

│   └── types/

├── scripts/       (GitHub automation)

├── TODO.md        (progress)

├── package.json

└── README.md ← Updated

```

---

## 🚀 Quick Start

1. **Install**: `npm install`

2. **Env**: `npm run env:setup` + edit `.env`:

```

NODE_ENV=development

LOCAL_PORT=3001

MONGO_URI=... or MONGOBD_USER/PASSWORD

TOKEN_SECRET=... (32+ chars)

TOKEN_REFRESH=...

SESSION_SECRET=...

REDIS_URL=redis://localhost:6379  # Optional

```

3. **Redis** (rec.): `brew install redis && redis-server`

4. **Dev**: `npm run dev` → http://localhost:3001/health

5. **Build/Test**: `npm run build` / `npm test`

**Prod**: `npm run start`

---

## 📚 API Endpoints (v1 - JWT required except auth)

### Auth `/api/v1/auth`

| Method | Path        | Desc            |

| ------ | ----------- | --------------- |

| POST   | `/register` | Create user     |

| POST   | `/login`    | Get tokens      |

| POST   | `/logout`   | Blacklist token |

| POST   | `/refresh`  | Renew access    |

### Candidate `/api/v1/candidate`

| Method    | Path      | Desc        |

| --------- | --------- | ----------- |

| GET       | `/:email` | Get profile |

| PUT/PATCH | `/`       | Update      |

### CRUD Pattern (all sections)

**Paths**: `/api/v1/{education,experience,award,certificate,project,reference,generalInformation}`

| Method | Path | Desc |

|--------|------|------|

| GET | `/` | List |

| POST | `/create` | Create |

| PUT | `/update` | Update |

| DELETE | `/delete/:id` | Delete |

**Header**: `Authorization: Bearer `

---

## 🔐 Auth Flow

1. **Login** → `{token, tokenRefresh}`

2. **API Calls**: `Authorization: Bearer ${token}`

3. **Refresh**: POST `/auth/refresh`

4. **Logout**: Blacklist (Redis/utils/tokenBlacklist.ts)

5. **Invalid**: Checked via Redis/mem store

---

## 🧪 Scripts & Testing

**Scripts**:

- `npm run dev` - Hot reload

- `npm run build` - Compile + copy assets

- `npm run test` - Jest

**Tests (~20 files)**: auth.service/controller, middlewares (rateLimit/logger/verify), utils (bcrypt/valid), database/mongo

---

---

## 🛡️ Production Notes

- **Rate Limit**: Redis (fallback mem), exempt `/health`

- **Blacklist**: Redis/utils/tokenBlacklist.ts

- **Logs**: Winston daily rotation

- **Static**: public/ (CSS/JS/fonts/img/PDFs)

- **PDF**: services/createPDF.ts + views/

---

## 🐛 Troubleshooting

| Issue        | Fix                                  |

| ------------ | ------------------------------------ |

| Mongo fail   | MONGO*URI or MONGOBD*\* vars         |

| Redis fail   | `brew install redis` or mem fallback |

| JWT invalid  | Token expired/blacklisted            |

| Rate limited | Wait / check Redis                   |

| Build fail   | `npm run copy`                       |

| Logs         | Check `logs/` (Winston)              |

---

## 📞 Support

Để báo cáo bug hoặc đề xuất tính năng, vui lòng tạo issue trên repository.

---

## 👨‍💻 Author

**Đạt Võ** - [github.com/datvt243](https://github.com/datvt243)