hmpps-registers

Running the app

The easiest way to run the app is to use docker compose to create the service and all dependencies.

docker-compose pull

docker-compose up

Dependencies

The app requires:

• hmpps-auth - for authentication
• redis - session store and token caching

Running the app for development

To start the main services excluding the example typescript template app:

docker compose up --scale=app=0

Create an environment file by copying .env.example -> .env Environment variables set in here will be available when running start:dev

Install dependencies using npm install, ensuring you are using node v20

And then, to build the assets and start the app with nodemon: Note: Using nvm (or fnm), run nvm install --latest-npm within the repository folder to use the correct version of node, and the latest version of npm. This matches the engines config in package.json and the CircleCI build config.

And then, to build the assets and start the app with esbuild:

npm run start:dev

Run linter

npm run lint

• npm run lint runs eslint.
• npm run typecheck runs the TypeScript compiler tsc.

Run unit tests

npm run test

Run:

npm run test-coverage

Running integration tests

For local running, start a test db, redis, and wiremock instance by:

docker compose -f docker-compose-test.yml up

Then run the server in test mode by:

npm run start-feature (or npm run start-feature:dev to run with auto-restart on changes)

And then either, run tests in headless mode with:

npm run int-test

Or run tests with the cypress UI:

npm run int-test-ui

Change log

A changelog for the service is available here

Dependency Checks

The template project has implemented some scheduled checks to ensure that key dependencies are kept up to date.

Types

Run the following:

npx openapi-typescript https://prison-register-dev.hmpps.service.justice.gov.uk/v3/api-docs --output server/@types/prisonRegisterImport/index.d.ts