Safeplaces Backend Ingestion Example

This repository holds an example backend for the ingestion API Safeplaces API specification.

Safeplaces is a toolkit for public health, built on top of data shared by users of Private Kit.

Safeplaces Frontend is an example client for these backends.

Project Status

The project is still under development and will reach a Minimum Viable Product (MVP) stage soon.
Note: There can be breaking changes to the developing code until the MVP is released.

Deployment

Deploy in local machine

Note:

1. The installation assumes you have already installed Postgres DB in your local environment listening for connections at port 5432.
2. Your Postgres instance should listen to '*' instead of 'localhost' by setting the listen_addresses parameter, this setting can be found in your pgconfig file.

Clone this repository

  

cd safeplaces-backend/expressjs

  

Install Package Manager

Steps to install NVM are documented in the nvm repository.

Install npm using nvm

  

nvm install 13.1.0

  

nvm use 13.1.0

  

npm install

  

Setup Environment

Refer .env.template for environment variables to be exported to your environment.

Setup Database

1. Create databases and users mentioned exported in your environment.
2. Grant database user superuser privilege to the database to create POSTGIS extension and setup other tables. Reduce this privilege later to just create and modify tables or tuples in this database after you run the migration for the first time.
3. Install PostGIS extension.

Knex migrations and seed the database

Install Knex globally

  

npm install knex -g

  

Run migrations

  

knex migrate:latest --env test

  

knex migrate:latest --env development

  

Seed the database

  

knex seed:run --env test

  

knex seed:run --env development

  

Mocha unit tests

Install mocha globally.

  

npm install mocha -g

  

Run testing through mocha to see if unit tests pass

  

mocha

  

Deploy using Docker

Note:

1. The installation assumes you have already installed Postgres DB in your local environment listening for connections at port 5432.
2. Your Postgres instance should listen to '*' instead of 'localhost' by setting the listen_addresses parameter, this setting can be found in your pgconfig file.
3. Your pg_hba.conf should have a rule added for host all all <docker-subnet> md5. Replace <docker-subnet> with the actual CIDR for your docker installation's subnet. Note that 172.18.0.0/16 is usually the default.

Clone this repository

  

cd safeplaces-backend/expressjs

  

Build Dockerfile

  

docker build -t safeplaces-backend-expressjs .

  

Run Dockerfile

docker run --rm --name safeplaces-expressjs --env-file=.env -p 3000:3000 safeplaces-backend-expressjs

Note: sample env file can be found at .env.template`.

Deploy via docker-compose

Using docker-compose will bring a postgres server along with the application container

Ensure to create application Environment variables file .env from .env.template

Ensure to create Postgres Environment variables file .database.env from .database.env.template

Run the following:

docker-compose build
docker-compose up

Testing Your Deployment

Run:

curl http://localhost:3000/health

Should respond with:

{
  "message": "All Ok!"
}