/nestjs-rest-sample

NestJS RESTful APIs Sample

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

NestJS Sample

Compile and build Build Docker Image Run e2e testing codecov

A NestJS RESTful APIs sample project, including:

  • Restful APIs satisfies Richardson Maturity Model(Level 2)
  • Custom Mongoose integration module instead of @nestjs/mongoose
  • Passport/Jwt authentication with simple text secrets
  • Fully testing codes with Jest, jest-mock-extended, ts-mockito, @golevelup/ts-jest etc.
  • Github actions workflow for continuous testing, code coverage report, docker image building, etc.

Docs

Build

Install the dependencies.

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Reference