Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vndevteam/nestjs-boilerplate
NestJS boilerplate
https://github.com/vndevteam/nestjs-boilerplate
commitizen commitlint docker docker-compose estlint github-actions husky jest lint-staged nestjs openapi pnpm postgresql prettier renovate typeorm typescript vscode vuepress
Last synced: 3 months ago
JSON representation
NestJS boilerplate
- Host: GitHub
- URL: https://github.com/vndevteam/nestjs-boilerplate
- Owner: vndevteam
- License: mit
- Created: 2024-06-06T16:07:47.000Z (5 months ago)
- Default Branch: develop
- Last Pushed: 2024-08-07T12:35:13.000Z (3 months ago)
- Last Synced: 2024-08-08T08:13:11.111Z (3 months ago)
- Topics: commitizen, commitlint, docker, docker-compose, estlint, github-actions, husky, jest, lint-staged, nestjs, openapi, pnpm, postgresql, prettier, renovate, typeorm, typescript, vscode, vuepress
- Language: TypeScript
- Homepage: https://vndevteam.github.io/nestjs-boilerplate/
- Size: 1.09 MB
- Stars: 66
- Watchers: 3
- Forks: 26
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: docs/security.md
Awesome Lists containing this project
- awesome-nestjs - NestJS Boilerplate with Awesome Docs - A NestJS boilerplate with SWC builder, PNPM, Auth, TypeORM, PostgreSQL, Seeding data (TypeORM Extension), Mailing (@nestjs-modules/mailer, nodemailer), Logging (Pino), Exception Handling, I18N, Dockerization (Local development, production), Swagger, Document (Vuepress), Lint & format (ESLint, Prettier, Editorconfig, Husky, Lint-Staged, Commitlint), Tests, CI. (Resources)
README
A NestJS boilerplate for starting a new project faster.
## Description
NestJS boilerplate for a typical project
Demo:
## Getting started
```bash
# Clone the repository
git clone https://github.com/vndevteam/nestjs-boilerplate.git
# Create environment variables file.
cp .env.example .env
# Install dependences.
pnpm install
```
## Checklist
When 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 `.github` folder which contains the funding info
- [ ] Clean up the README.md file
## Running the app
```bash
# development
$ pnpm start
# watch mode
$ pnpm start:dev
# production mode
$ pnpm start:prod
```
## Features
- [x] Database. Support [TypeORM](https://www.npmjs.com/package/typeorm)
- [x] Seeding ([Typeorm Extension](https://www.npmjs.com/package/typeorm-extension)).
- [x] Config Service ([@nestjs/config](https://www.npmjs.com/package/@nestjs/config)).
- [x] Mailing ([@nestjs-modules/mailer](https://www.npmjs.com/package/@nestjs-modules/mailer) & [nodemailer](https://www.npmjs.com/package/nodemailer)).
- [x] Sign in and sign up via email.
- [ ] Social sign in (Apple, Facebook, Google, Twitter).
- [ ] Admin and User roles.
- [x] Pagination: Offset and Cursor (Clone from [typeorm-cursor-pagination](https://github.com/benjamin658/typeorm-cursor-pagination) and add more features).
- [x] Internationalization/Translations (I18N) ([nestjs-i18n](https://www.npmjs.com/package/nestjs-i18n)).
- [ ] File uploads. Support local and Amazon S3 drivers.
- [x] Swagger.
- [ ] E2E and units tests.
- [x] Docker.
- [x] CI (Github Actions).
## More documentations
Please read the [docs](docs/README.md). It contains the details about the project structure, conventions, and more.
## References
- [Awesome Nest Boilerplate](https://github.com/NarHakobyan/awesome-nest-boilerplate)
- [Brocoders NestJS Boilerplate](https://github.com/brocoders/nestjs-boilerplate)
## Support
[Discuss on Github](https://github.com/vndevteam/nestjs-boilerplate/discussions)