RESTful API built with TypeScript, Express, and Mongoose, following a clean MVC architecture.
Includes authentication, authorization, and integration testing using Vitest and Supertest.

• 🧩 Question Management – Create, edit, delete, and retrieve questions.
• 📚 Collections System – Group questions into collections.
• 👤 User Authentication – Register, login, and manage users securely.
• ��� JWT Tokens – Stateless authentication for users.
• 🛡️ Role-Based Permissions – Admin and standard user access control.
• 🧪 Integration Testing – Powered by Vitest, Supertest, and mongodb-memory-server.
• ⚙️ Clean Architecture (MVC + OOP) – Modular and scalable project structure.
• 📖 API Documentation – Auto-generated using Swagger UI.
• 🪵 Structured Logging – Using Pino and Morgan for detailed request logs.
• 🧰 Validation & Security – Helmet, Rate Limiting, HPP, Express Validator, and CORS.

src/
├── main.ts         🏛️
├── configs/        📄
├── controllers/    🎮
├── databases/      🗃️
│ └── mongoose.ts   🧺
├── dtos/
├── interfaces/
├── middlewares/    ⚔️
├── models/         🏘️
├── routes/         🛣️
├── utils/          🛠️
├── constants.ts
├── .env.test       🧪
├── .env.production 🚀
├── .env.example
└── .env            🏗️

• Controllers → Handle HTTP requests/responses.

• Services / Modules → Business logic, injected via tsyringe.

• Models → Mongoose schemas.

• DTOs & Interfaces → Define TypeScript types and contracts.

• Middlewares → Validation, Auth, Logging, Error handling.

• Utils → Helpers (e.g., token generation, formatting).

Follows Clean Architecture principles with OOP and dependency injection.

• Run tests once
  • npm run test
• Run tests in watch mode
  • npm run test:watch

Swagger UI is available at: http://localhost:8080/api/docs

Automatically generated from JSDoc annotations using:

• swagger-jsdoc

• swagger-ui-express

1. User registers (/api/v1/auth/register)

2. User logs in and receives JWT token

3. Token must be included in headers:

   • Authorization: Bearer

4. Middleware verifies token and applies role-based access (e.g. EDIT_COLLECTION, DELETE_QUESTION)

Contributions, issues, and feature requests are welcome!
Feel free to open a pull request or issue.

1. Fork the repo
2. Create a new branch (feature/my-feature)
3. Commit your changes
4. Push to your branch
5. Open a Pull Request 🚀

MIT © 2025 @Garkatron