API Documentation

npm nodejs nestjs

Description

This project is building using NestJS and MongoDB

Nest packages:

Requirements

Technology Version
NodeJS 20.X
MongoDB 5.0

Notes:

  • There is a docker-compose.yml with mongodb dependency, just use nvm to switch node version.

Installation

  1. Install dependencies
  2. Install husky hooks
  3. Launch server

Install dependencies

yarn install

Install and configure husky

npx husky install

Launch

You can launch some architecture dependencies with Docker using Docker Compose.

Start services

yarn hello

Stop services

yarn bye
Services -
MongoDB 5.0

Documentation

Swagger View
Compodoc View

Testing

Run unit testing band

yarn test

Run end to end testing band

yarn test:e2e

Examples

Read more about examples here