URLs

The backend system is deployed to here

The API documentation can be inspected here

The build logs - Travis CI

Key Technologies

Core

• Node.js v8.11.2
• Express.js v4.16.4

Databases

• PostgresSQL
• Sequelize

Testing

• mocha
• chai

Setup

Prerequisite

• Homebrew (MacOS)
• Chocolatey (Windows)

Node

1. Install nvm with brew install nvm.
2. Install node 8.11.2 with nvm install 8.11.2.
3. From the root directory of this project, run nvm use 8.11.2.
4. Run npm install

Database

1. Install PostgreSQL on your local machine. The instructions for this very from operating system to operating system.

$ brew install postgresql

2. Start PostgreSQL and run on startup.

$ brew services start postgresql

3. Ensure a root user exists on PostgreSQL with no password:

$ psql --dbname=postgres
postgres=# CREATE USER root;
postgres=# ALTER USER root WITH SUPERUSER;

4. Create the database by running:

$ npm run db:create

5. Create the database tables by running:

$ npm run db:migrate

Testing

To run the tests, simply run

$ npm run test

To generate the code coverage

$ npm run test:coverage