This project is built using NestJS, a progressive Node.js framework for building efficient and scalable server-side applications.
.
├── app.controller.ts
├── app.module.ts
├── app.service.ts
├── config/
│ ├── config.module.ts
│ ├── database/
│ │ └── database.module.ts
│ ├── env.configuration.ts
│ └── env.validation.ts
├── core/
│ ├── constants/
│ │ └── index.ts
│ └── enums/
│ └── index.ts
├── main.ts
├── modules/
└── shared/
├── decorators/
├── exception-filters/
├── guards/
├── interceptors/
├── middleware/
├── pipes/
├── presenter/
├── utils/
└── validators/
app.controller.ts,app.module.ts,app.service.ts: Main application filesconfig/: Configuration-related modules and filescore/: Core application constants and enumsmain.ts: Application entry pointmodules/: Feature modules (currently empty, ready for future development)shared/: Shared components, utilities, and helpers
The project uses a configuration module for managing environment variables and database connections.
Swagger is set up for API documentation. Access it at /api/swagger when the application is running.
- Node.js
- pnpm (Package manager)
pnpm install# development
pnpm run start
# watch mode
pnpm run start:dev
# production mode
pnpm run start:prodpnpm run generate:postman- 🗜️ Compression for optimized responses
- 🛡️ Helmet for security
- 🌐 CORS enabled
- ✅ Global validation pipe
- 📖 Swagger for API documentation
- 📄 OpenAPI spec generation
The project uses TypeScript with path aliases for easier imports. Check tsconfig.json for details.
Please read our contributing guidelines (link to CONTRIBUTING.md if available) before submitting pull requests.
MIT License (Add this file if not present)