Nest.js boilerplate
Node.js Nest.js API. Supports MongoDB, Mysql, Redis
Description
This generator will help you to build your own Nest.js Mongodb/MySQL API using TypeScript 4
Project Introduction
- Support ES6/ES7 features
- Using Eslint followed Airbnb JavaScript Style Guide
- Husky
- Commitizen
- MIT license and Code of conduct
- Docker
- Prettier
Features
Authentication
- passport local strategy
- jwt authentication
- passport google 2.0 strategy
Session Storage
- MongoDB
- Redis
- MySQL
Email Sending
- Nodemailer
Integration testing
- mocha
- chai
- supertest
Requirements
- node >= 12
- npm >= 6
- mongodb >= 4.0
- typescript >= 3.0
Installation
First, install Yeoman and generator-nest-js-boilerplate using npm (we assume you have pre-installed node.js).
npm install -g yo
npm install -g generator-nest-js-boilerplate
Then generate your new project:
yo nest-js-boilerplate
App Skeleton
├── src
│├── components
││├── app/
││├── auth/
││└── users/
│├── dto
│├── filters
│├── guards
│├── main.ts
│└── pipes
├── docker-compose.yml
├── index.js
├── nest-cli.json
├── package.json
├── package-lock.json
├── README.md
├── tsconfig.build.json
└── tsconfig.json
Running the API
Development
To start the application in development mode, run:
npm run start:dev
Start the application in production env:
Install ts pm2 and typescript compiler:
npm install -g pm2
pm2 install typescript
example start with scale on 2 core:
pm2 start ./dist/main.js -i 2 --no-daemon
Express server listening on http://localhost:3000/, in development mode The developer mode will watch your changes then will transpile the TypeScript code and re-run the node application automatically.
Docker
To run your app in docker containers choose "Yes" when the generator asks you about docker.
Now, lift up your app in docker
docker-compose up
Set up environment
In root folder you can find .env
. You can use this config or change it for your purposes.
Deploy
Heroku
Check all urls to dbs if they are true, they must connect to dbs which located at them own servers like mongodb on Mlab When you'll run npm run deploy:heroku you'll need to sign in on heroku. You will be redirected to login form.
npm run deploy:heroku
Swagger
Swagger documentation will be available on route:
http://localhost:3000/api
Jwt auth
Oauth2 auth
When you go by http://localhost:3000/google route, google'll ask you to authorize into your account. After successfully sign in to your account you will be redirected to http://localhost:3000/google/redirect route
Diagnose and pinpoint performance issues
Bubble
Doctor
Getting To Know Yeoman
- Yeoman has a heart of gold.
- Yeoman is a person with feelings and opinions, but is very easy to work with.
- Yeoman can be too opinionated at times but is easily convinced not to be.
- Feel free to learn more about Yeoman.