README.md

hmpps-organisations-api

API to support the creation, management and sharing of data related to organisations external to HMPPS.

Building the project

./gradlew
./gradlew clean test

Running the application locally

./run-local.sh

The application comes with a dev spring profile that includes default settings for running locally. This is not necessary when deploying to kubernetes as these values are included in the helm configuration templates - e.g. values-dev.yaml.

Most services which run locally will rely upon the DEV environment for dependant APIs, but will need a database running locally. This can be started with:

docker compose pull && docker compose up -d