NestJS Boilerplate Documentation

This is a boilerplate for NestJS projects. It is a starting point for building a RESTful API with NestJS.

Detail Documentation

• Setup & Development
• Architecture
• Database
• Security
• Testing
• Deployment
• Technologies
• Troubleshooting
• Convention
  • Naming cheatsheet
  • TypeScript Style Guide and Coding Conventions
  • Clean code Typescript
  • Branch conventions
  • Commit conventions
  • Linting & formatting

Features

• Fastify support. (Checkout the feature.fastify branch)
• Database. Support TypeORM
• Seeding (Typeorm Extension).
• Config Service (@nestjs/config).
• Mailing (@nestjs-modules/mailer & nodemailer).
• Sign in and sign up via email.
• Social sign in (Apple, Facebook, Google, Twitter).
• Admin and User roles.
• Pagination: Offset and Cursor (Clone from typeorm-cursor-pagination and add more features).
• Internationalization/Translations (I18N) (nestjs-i18n).
• File uploads. Support local and Amazon S3 drivers.
• Swagger.
• E2E and units tests.
• Docker.
• CI (Github Actions).

References

• TypeScript
• NestJS
• NestJS I18n
• TypeORM
• TypeORM Extension
• Nodemailer
• NestJS Mailer
• Jest
• PNPM
• ESLint
• TypeScript ESLint
• Prettier
• Husky
• Lint Staged
• Commitlint
• Conventional Commits
• Commitizen
• Renovate