A NestJS boilerplate for starting a new project faster.
NestJS boilerplate for a typical project
Demo: https://nestjs-boilerplate-n27l.onrender.com/api-docs
# Clone the repository
git clone https://github.com/vndevteam/nestjs-boilerplate.git
# Create environment variables file.
cp .env.example .env
# Install dependences.
pnpm installWhen you use this template, try follow the checklist to update your info properly
- Change the author name in
LICENSE - Change configurations in
.env - Remove the
.githubfolder which contains the funding info - Clean up the README.md file
# development
$ pnpm start
# watch mode
$ pnpm start:dev
# production mode
$ pnpm start:prod- 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).
Please read the docs. It contains the details about the project structure, conventions, and more.