README.md

server

API server built with the Nest framework.

Installation

npm install

Other than npm dependencies, git is also needed to be available in path for npm postbuild script to run.

Create the .env file

1. Create a new .env file following this env-sample file.
2. See this table describing all env vars

Running the app

Development mode (watch files and perform live reload)

npm run serve

Build and run in production mode

# Build app first before running the app
npm run build

# Run the build output
npm run start

Debug mode

npm run start:debug

Deployment

Build docker image

npm run docker:build

Run docker image

npm run docker:run

Run docker image and attach it to current shell

npm run docker:run-attached

Test

# unit tests
npm run test

# e2e tests
npm run test:e2e

# test coverage
npm run test:cov