README.md

dump-server

---

---

A RESTful API for querying and saving planet dump's metadata.

API

Checkout the OpenAPI spec here

Postgres prerequisite

uuid-ossp extension must be installed in the database before you run the migrations.

Run Migrations

don't forget to run migrations before you start the app

Shell

Just run the following command

npm run migration:run

Docker

Build the migrations image

docker build -t dump-server-migrations:latest -f migrations.Dockerfile .

then simply run

docker run -it --rm --network host dump-server-migrations:latest

If you want to change the connection properties you can do it via either:

1. Env variables
2. Inject a config file based on your environment

Via env variables

docker run -it -e DB_USERNAME=VALUE  -e DB_PASSWORD=VALUE -e DB_NAME=VALUE -e DB_TYPE=VALUE -e DB_HOST=VALUE -e DB_PORT=VALUE --rm --network host dump-server-migrations:latest

Via injectiong a config file, assuming you want to run the migrations on your production

production.json:

{
  "openapiConfig": {
    "filePath": "./openapi3.yaml",
    "basePath": "/docs",
    "rawPath": "/api",
    "uiPath": "/api"
  },
  "logger": {
    "level": "info"
  },
  "server": {
    "port": "8080"
  },
  "db": {
    "type": "postgres",
    "host": "localhost",
    "port": 5432,
    "username": "prod_avi",
    "password": "prod_avi",
    "database": "prod_avi"
  }
}

docker run -it --rm -e NODE_ENV=production --network host -v /path/to/proudction.json:/usr/app/config/production.json dump-server-migrations:latest

---

Build and Run

npm install
npm start

Test

integration:

test against a postgres db

DB_TYPE=postgres DB_HOST=VALUE DB_PORT=VALUE DB_USERNAME=VALUE DB_NAME=VALUE DB_PASSWORD=VALUE npm run test:integration

unit

npm run test:unit