Book a secure move frontend

Book a secure move is part of the HMPPS Prisoner Escort and Custody Service (PECS) programme.

There are three main repositories that comprise the Book a secure move service:

• This is the rendering application for the Book a secure move service.
• There is an api repository that contains the backend API
  • This is the primary backend service providing most of the data used by the frontend application.
  • There is another external system, NOMIS Elite 2 API, which is also used for some data requests.
• There is a shared framework repository
  • This contains sections, steps and questions needed to complete journeys. Currently it only supports the Person Escort Record.
  • Further integration details can be found here

Quick Start

Major Dependencies

• Node.js (>= 16.13.1)
• NPM (>= 8.1.0)
• Redis (>= 5.0.5)

Installation

1. Clone repository and change directory:

   git clone https://github.com/ministryofjustice/hmpps-book-secure-move-frontend && cd hmpps-book-secure-move-frontend
   

2. Install node dependencies:

   npm install
   

3. Build the assets

   npm run build
   

Configuring the application

Create a copy of the example environment variable file and add values for the keys:

cp .env.example .env

Set the environment variables accordingly.

Running the application

In production mode

NODE_ENV=production npm start

The app will run on port 3000 by default and be available at http://localhost:3000.

In development mode

Ensure Redis is installed and running.

npm run develop

The app will be running at http://localhost:3000 or with browsersync at http://localhost:3001.

Licence

Unless stated otherwise, the codebase is released under the MIT License.

Contribution guidelines

If you want to help us improve Book a secure move, view our contribution guidelines