API Documentation

Description

This project is building using NestJS and MongoDB

Nest packages:

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.

Install dependencies

yarn install

Install and configure husky

npx husky install

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

Start services

yarn hello

Stop services

yarn bye

Services	-
MongoDB	5.0


Swagger	View
Compodoc	View

Run unit testing band

yarn test

Run end to end testing band

yarn test:e2e

Name		Name	Last commit message	Last commit date
Latest commit History 15 Commits
.bruno		.bruno
.github/workflows		.github/workflows
.husky		.husky
.vscode		.vscode
documentation		documentation
src		src
test		test
.deepsource.toml		.deepsource.toml
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.env.example		.env.example
.env.testing		.env.testing
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.nvmrc		.nvmrc
.prettierrc		.prettierrc
Dockerfile		Dockerfile
EXAMPLE.md		EXAMPLE.md
README.md		README.md
deploy.sh		deploy.sh
docker-compose.yml		docker-compose.yml
docker.sh		docker.sh
jest-e2e.json		jest-e2e.json
jest.config.json		jest.config.json
nest-cli.json		nest-cli.json
package.json		package.json
tsconfig.build.json		tsconfig.build.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock