A starter project for quickly building production-ready RESTful APIs using TypeScript, Node.js and Express.
- Create structured, declarative, and organized class-based app with heavy decorators usage using TypeScript and Routing Controllers Framework
- Validation: request data validation using class-validator
- Environment variables: using dotenv and cross-env
- Dependency injection: using typedi
- SQL database: object data modeling using TypeORM
- Gracefully shutdown: Gracefully terminate the server using http-terminator
- Compression: gzip compression with compression
- Security: set security HTTP headers using helmet
- CORS: Cross-Origin Resource-Sharing enabled using cors
- Linting: with ESLint and Prettier
- Clone the repo
- Install the dependencies:
npm install- Set the environment variables:
cp .env.example .env
# open .env and modify the environment variables (if needed)Running locally:
npm run start:devRunning in production:
npm run start:prod