README.md

HMPPS Sentence Plan UI

This project aims to enhance the current process of creating and managing sentence plans for individuals on probation or in prison.

Pre-requisites

In order to run this project, the following software is required:

• Make - A command line interface tool for summerising common function calls
• Docker - An open-source application packager for platform agnostic deployable software
• Node.js - A JavaScript runtime environment and library for running web based applications

Running the application

Note:

• This service and all of its dependencies are run in Docker containers
• Every command can be printed using make
• Due to requiring authentication through the ARNS Handover Service, to access the Sentence Plan UI, you can create a handover through the OAStub hosted at http://localhost:7072 and select Sentence Plan as the target service.

Production

Note: Before starting, run make install-node-modules to install dependencies.

1. To start a production version of the application, run make up
   • The service will start on http://localhost:3000
   • To check the health status, go to http://localhost:3000/health
2. To update all containers, run make down update up

Development

1. To start a development version of the application, run make dev-up
   • The service will start on http://localhost:3000
   • A debugger session will be accessible on http://localhost:9229
   • To check the health status, go to http://localhost:3000/health
2. The application will live-reload as you make changes to the code.

Note: Each time you change or update your node dependencies, run make install-node-modules to have these reflected in your Docker container.

You can connect to the remote debugger session on http://localhost:9229 like so

Testing

The test suite can be run using make test

Linting

Linting can be run using make lint and make lint-fix