This repository hosts the Alerts User Interface, a frontend application for managing, recording, and maintaining reference data for alerts across HMPPS services. Developed with Typescript, this project aims to provide a robust platform for alert data management, enhancing the operational efficiency and data accuracy within HMPPS.
- Make a copy of the
.env.local
file and rename it to.env
- Ensure that
HMPPS_ALERTS_UI_APPINSIGHTS_KEY
,HMPPS_ALERTS_UI_API_CLIENT_ID
,HMPPS_ALERTS_UI_API_CLIENT_SECRET
,HMPPS_ALERTS_UI_SYSTEM_CLIENT_ID
,HMPPS_ALERTS_UI_SYSTEM_CLIENT_SECRET
and any other system vars prefixed with$
in your new.env
file are populated either via your.zprofile
or.bash_profile
file or similar, or hard-code the secrets/keys into the .env file directly. This file is ignored by git so should never be committed. In order to get the actual values of these you will need to get and transform the values from k8s like so:kubectl get secrets/<secret_collection_name> --template={{.data.<secret>}} | base64 -d
. Repeat this for other env vars needed. Please see https://user-guide.cloud-platform.service.justice.gov.uk/documentation/getting-started/kubectl-config.html for guidance on K8s access. - Ask someone with access to manage user accounts in HMPPS Digital Services to create you a new user
- Run
npm ci
to install the dependencies - Run
npm run build
to compile the styling and build the views - Run
npm run start:dev
to start the UI - Use the new user details you got given to log in