Skip to content

ministryofjustice/hmpps-hdc-api

Repository files navigation

hmpps-hdc-api

repo standards badge CircleCI Docker Repository on Quay API docs

This is an API for accessing HDC data.

Currently, the main DB definition exists in the licences repo and the schema is managed by knex migrations. Any schema changes need to be applied to that repo.

A copy of the schema exists in this repo for aid of local development - in the short term, any schema changes that are applied via knex migrations to the production DBs will need to be back ported to this repo.

The aim is to make this project manage migrations in the mid/long term.

Running locally

There is a run-local.sh script that can be run to start and stop docker containers and build and run the application.

There are currently 3 modes:

  1. ./run-local.sh --start-docker - starts docker images, waits for them to start and then runs the app against a standalone licences DB
  2. ./run-local.sh - waits/checks that the requisite docker images exist and then runs the app against a standalone licences DB
  3. ./run-local.sh --connect-db - runs the app against the frontend licences DB docker image (requires localstack running)

About

API for managing HDC licences

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •