hmpps-official-visits-api

HMPPS Official Visits API

Policies

Our security policy is located here.

Instructions for building the project

Initialise gradle - only required the first time

./gradlew

Clean and build, and run unit and integration tests

./gradlew clean build test

Running the application locally

The application comes with a local spring profile that includes default settings for running locally.

Setting a profile is not necessary when deploying to kubernetes as these values are included in the helm configuration templates - e.g. values-dev.yaml, values-preprod.yaml and values-prod.yaml

There is a script run-local.sh which sets up environment variables required to run locally, which override the value defaults, providing the local equivalents for values provided by Kubernetes secrets. You should not include any sensitive values in the run-local.sh, so it should pull these in from your environment, or a .env file locally.

There is also a docker-compose.yml that can be used to start the dependencies of the project as local docker containers. This will pull (if required), and start a local postgresql container in docker.

docker compose pull && docker compose up -d

Then run the service with the script:

./run-local.sh