Skip to content
This repository has been archived by the owner on Oct 1, 2020. It is now read-only.

Latest commit

 

History

History
47 lines (46 loc) · 1.45 KB

README.md

File metadata and controls

47 lines (46 loc) · 1.45 KB

Contact Tracing API Service

Set up Backend API

​ The backend API consists of both a Fastify server and a PostgreSQL database. To get these running will require the following steps. You will need Docker installed to run the database. ​

  • Install the dependencies and create a basic environment configuration. ​
npm install
npm run create:env

  • Next, start the database. This will download and install the PostgreSQL container. ​
npm run db:up

  • If this is your first time running the database, you have previously deleted it, or migrations have been added, you will need to run migrations. ​
npm run db:migrate

  • Finally, start the server in development mode. ​
npm run start:dev

Backend API Development

​ There are a number of handy commands you can run to help with development. ​

Command Action
npm run start:dev Run the server in dev mode, automatically restarts on file change
npm run create:env Create a new .env file
npm test Run unit tests
npm run test:watch Run backend tests in watch mode, running on changed test files
npm run db:migrate Run database migrations.
npm run db:up Run the database server
npm run db:down Shutdown the database server
npm run db:delete Delete the database server. You will need to run db:up and db:migrate again.
npm run lint Run eslint
npm run lint:fix Run eslint in fix mode