Zest

A NestJS API

Environment

Rename the .env.example file to .env and set all avaliable fields.

# .env file
PORT=3000

MONGODB_URI='mongodb://127.0.0.1/zest'

EMAIL_PORT=2525
EMAIL_HOST='smtp.example.io'
EMAIL_USER='zest@zest.com'
EMAIL_PASS='supersecretpw'
EMAIL_NAME='Zest' # This will be the sender name
EMAIL_ADDR='no-reply@zest.com' # This will be the sender email

Installation

$ yarn

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# incremental rebuild (webpack)
$ npm run webpack
$ npm run start:hmr

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Features

• Environment variables inside .env file
• Continous Integration with Travis CI
• Continous Quality with SonarCloud
• API Documentation with Swagger
• Automated Tests with Jest
• Run automated tests before commits for staged files
• MongoDB Integration with mongoose
• JWT Based Authentication