generator-exprest-api

Express / Rest API generator

Yeoman generator for creating REST APIs with Express

Included

• TypeScript support
• RESTful API - Using Express
• Dependency injection - Using typedi
• Standard error responses - Using http-errors

Features / options

• Database ORM - Using Sequelize (MySQL and PostgreSQL support)
• Docker containerization - Using Docker Compose
• Testing - Using Jest and Supertest
• Logging - Using Winston
• HTTP requests logging - Using morgan
• Internationalization - Using i18next
• Error tracking - Using Sentry
• Caching - Using Redis
• API documentation - Using OpenAPI and ReDoc
• Object validation - Using celebrate and Joi
• Email sending - Using Nodemailer
• Real-time events - Using Socket.IO
• Admin panel - Using AdminJS
• API status monitoring - Using express-status-monitor
• Cron jobs - Using node-schedule
• Code formatting - Using Prettier
• Code linting - Using ESLint
• Pre-push linting hook - Using husky and lint-staged

Installation

First, install Yeoman and generator-exprest-api using npm.

yarn global add yo generator-exprest-api

Usage

Then generate your new project with:

yo exprest-api

NOTE: No need to create a new folder before running the command, the generator will do it for you.

TODO

• [ ] Add internationalized validation errors
• [ ] Add multer for file upload support
• [ ] Migrate ORM to MikroORM ?
• [ ] Add user.verifiedAt property

License

MIT © Arthur Fauquenot