README.md

PROJECT SETUP

Local Environment Setup

• Git
• Node.js v14.5.0
• Yarn v1.22.5
• PostgreSQL v12
• pgAdmin
• Visual Studio Code

Environment Variables for Local Development

Create a .env file and adjust the following environment variables. DONOT include the file in the source control.

DB_NAME=<value>
DB_USER=<value>
DB_PASSWORD=<value>
COOKIE_SECRET=<value>
TOKEN_SECRET=<value>
PORT=<value>

Create a database in mysql of XAMPP, put the name on DB_NAME

NPM Scripts

$ yarn install          # install dependencies
$ yarn seed             # generate required database schemas
$ yarn start            # development build
$ yarn production       # production build
$ yarn test             # run unit tests
$ yarn sonarqube        # generate sonarqube analysis

API Documentation

Go to /api-docs for Swagger Documentation of the API.