A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

Built with

• 
• 
  • JWT
  • Swagger
  • Class validator
  • Custom validators for database constraints
  • TypeORM
• 
• 
• 
• 

Prints 📷

Swagger

URL: /api

Friendly errors on response

• Custom validators
  • Unique constraint
  • Exist constraint

• All errors are returned inside "errors" key on response.
• Validate model data before saving to database to get all database errors (via custom validators)

Test coverage

e2e coverage (96%!)

Installation

$ npm install
$ cp .env.example .env

Running the app

# migrate database
$ npm run migration:run

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Docker

1. change DB_HOST in .env to DB_HOST=postgres
2. run:

# run docker in background
$ docker-compose up -d

# run migrations
$ docker-compose exec dev npm run migration:run

• Run tests with docker

# up postgres service
$ docker-compose up postgres

# run unit tests
$ docker-compose exec dev npm run test

# run e2e tests
$ docker-compose exec dev npm run test:e2e

Database

# migrate database
$ npm run migration:run

# revert last migration
$ npm run migration:revert

# generate migration
$ npm run migration:generate

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Roadmap

• TypeORM
• Migrations
• CRUD User
• CRUD Notification
• JWT
  • Access Token
  • Refresh Token
• Pagination
• Unit tests
  • Use cases
  • Controllers
  • Coverage 100% (30%)
• e2e tests
  • Coverage 100% (96% is almost 100% 👌)
• Database constraints
• Fix docker
  • Update README.md with docker steps
• Run tests on Pull Requests
• PR template

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.