ChaneyZhao/nestjs-rest-sample

NestJS RESTful APIs Sample

NestJS Sample

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

• Getting Started
• Connecting to MongoDB
• Protect your APIs with JWT Token
• Dealing with model relations
• Externalizing the configuration
• Handling user registration
• Testing Nestjs applications

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

• The official Nestjs documentation
• Unit testing NestJS applications with Jest
• ts-mockito: Mocking library for TypeScript inspired by http://mockito.org/
• Clock-in/out System Series
• Modern Full-Stack Development with Nest.js, React, TypeScript, and MongoDB: Part 1, Part 2
• Code with Hugo - Jest Full and Partial Mock/Spy of CommonJS and ES6 Module Imports
• There is a collection of courses from https://wanago.io/ which is very helpful for building applications with NestJS:
  • API with NestJS
  • Series: TypeScript Express tutorial
  • Series: Node.js TypeScript
  • Series: JavaScript testing tutorial