Boilerplate

Setup

Install yarn globaly.

npm install -g yarn

Install dependencies.

yarn install

Setup the environment variables.

.env can be used.

NODE_ENV="<environment>"
PORT="<port>"
DATABASE_URL="<database URL>"

Example:

NODE_ENV=development
PORT=3000
DATABASE_URL=postgres://dev:dev@localhost:5432/boilerplate

Development

To start the server watching changes.

yarn debug

Production

yarn build
yarn server

Documentation

This project uses Swagger UI to display the documentation. It initializes with the server, so to view it, start the server following the development or production instructions, and access /docs.