README.md

HMPPS Appointment Reminders UI

Management interface for monitoring probation appointment SMS reminders.

Get started

Pre-requisites

You'll need to install:

• NodeJS*

*If you're already using nvm or fnm, run: nvm install --latest-npm at the project root to install the correct Node version automatically.

Dependencies

Install NPM package dependencies:

npm install

Run the service

To run the service locally, with an in-memory session store and using WireMock to stub the dependencies, run:

npm run start:dev

Then, open http://localhost:3000 in your browser.

Integrate with dev services

Alternatively, you can integrate your local UI with the dev/test services deployed on MOJ Cloud Platform.

Create a .env file by copying the example provided:

cp -n .env.example .env

Run the following to grab client credentials from the dev namespace:

kubectl -n hmpps-appointment-reminders-dev get secret hmpps-appointment-reminders-ui -o json \
| jq -r '.data | map_values(@base64d) | to_entries[] | "\(.key)=\(.value)"' \
| grep CLIENT >> .env

Then, start the UI service:

npm run start:dev

Formatting

npm run lint # Check for formatting issues
npm run lint-fix # Fix formatting issues

Testing

Run unit tests

npm test

Running integration tests

To run the Cypress integration tests locally:

npm run int-test # Run the tests in headless mode
npm run int-test-ui # Run the tests with the Cypress UI

Support

For any issues or questions, please contact the Probation Integration team via the #probation-integration-tech Slack channel. Or feel free to create a new issue in this repository.