Template github repo used for new Typescript based projects.
If this is a HMPPS project then the creation of new services is automated and cloning/forking this repository is not required.
Documentation to create new services is located here.
This project is community managed by the mojdt #typescript slack channel.
Please raise any questions or queries there. Contributions welcome!
Our security policy is located here.
More information about the template project including features can be found here.
When deploying to a new namespace, you may wish to use the templates project namespace as the basis for your new namespace. This namespace contains both the kotlin and typescript template projects, which is the usual way that projects are setup. This namespace includes an AWS elasticache setup - which is required by this template project.
Copy this folder and update all the existing namespace references. If you only need the typescript configuration then remove all kotlin references. Submit a PR to the Cloud Platform team in #ask-cloud-platform. Further instructions from the Cloud Platform team can be found in the Cloud Platform User Guide
As part of the automation to create the new service, various parts of the codebase will be updated to reflect it's specific name.
The template project is set up to run with two sets of credentials, each one support a different oauth2 flows. These need to be requested from the auth team by filling in this template and raising on their slack channel.
These are used to allow authenticated users to access the application. After the user is redirected from auth back to the application, the typescript app will use the returned auth code to request a JWT token for that user containing the user's roles. The JWT token will be verified and then stored in the user's session.
These credentials are configured using the following env variables:
- AUTH_CODE_CLIENT_ID
- AUTH_CODE_CLIENT_SECRET
These are used by the application to request tokens to make calls to APIs. These are system accounts that will have their own sets of roles.
Most API calls that occur as part of the request/response cycle will be on behalf of a user. To make a call on behalf of a user, a username should be passed when requesting a system token. The username will then become part of the JWT and can be used downstream for auditing purposes.
These tokens are cached until expiration.
These credentials are configured using the following env variables:
- CLIENT_CREDS_CLIENT_ID
- CLIENT_CREDS_CLIENT_SECRET
To allow authenticated users to access your application you need to point it to a running instance of hmpps-auth.
By default the application is configured to run against an instance running in docker that can be started
via docker-compose.
NB: It's common for developers to run against the instance of auth running in the development/T3 environment for local development. Most APIs don't have images with cached data that you can run with docker: setting up realistic stubbed data in sync across a variety of services is very difficult.
When deployed to an environment with multiple pods we run applications with an instance of REDIS/Elasticache to provide a distributed cache of sessions. The template app is, by default, configured not to use REDIS when running locally.
The easiest way to run the app is to use docker compose to create the service and all dependencies.
The production image now uses the hmpps-node:24-alpine-runtime base image and starts with node dist/server.js directly, so npm is not present in the final runtime stage.
docker compose pull
docker compose up
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 run setup, ensuring you are using node v24
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 github pipeline build config.
And then, to build the assets and start the app with esbuild:
npm run start:dev
Once the application is running you should then be able to login with:
username: AUTH_USER password: password123456
To request specific users and roles then raise a PR to update the seed data for the in-memory DB used by Auth
By default no pre or post install scripts will be run during npm install.
Instead a list of configured install scripts will be run via the npm script allowlist tool.
Instead of running npm install, run npm run setup - this will run an npm ci to install any dependencies and then run any configured install scripts.
The hmpps precommit hooks library will ensure that prek is installed and initialised against the repo as part of npm run setup.
This will run a set of precommit hooks before every commit as configured in .pre-commit-config.yaml.
This will scan for potential secrets in the staged files and fail the commit if any are detected.
There's some guidance for dealing with false positives in the precommit hooks docs.
The secret scanner hook can also be configured as described here.
npm run lintrunseslint.npm run typecheckruns the TypeScript compilertsc.
npm run test
For local running, start a 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)
After first install ensure playwright is initialised:
npm run int-test-init:ci
And then either, run tests in headless mode with:
npm run int-test
Or run tests with the UI:
npm run int-test-ui
While there are multiple ways to keep your project up-to-date this method doesn't require you to keep cherry picking the changes, however if that works for you there is no reason to stop.
In your service, add the template as a remote:
git remote add template https://github.com/ministryofjustice/hmpps-template-typescript
Create a branch and switch to it, eg:
git checkout -b template-changes-2309
Fetch all remotes:
git fetch --all
Merge the changes from the template into your service source:
git merge template/main --allow-unrelated-histories
You'll need to manually handle the merge of the changes, but if you do it early, carefully, and regularly, it won't be too much of a hassle.
A changelog for the service is available here