Template github repo used for new Typescript based projects.
If this is a HMPPS project then the project will be created as part of bootstrapping -
see https://github.com/ministryofjustice/hmpps-project-bootstrap. You are able to specify a template application using the github_template_repo attribute to clone without the need to manually do this yourself within GitHub.
This bootstrap 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 this template typescript project namespace as the basis for your new namespace:
This template namespace includes an AWS elasticache setup - which is required by this template project.
Copy this folder, update all the existing namespace references, and submit a PR to the Cloud Platform team. Further instructions from the Cloud Platform team can be found here: https://user-guide.cloud-platform.service.justice.gov.uk/#cloud-platform-user-guide
Once the new repository is deployed. Navigate to the repository in github, and select the Actions tab.
Click the link to Enable Actions on this repository.
Find the Action workflow named: rename-project-create-pr and click Run workflow. This workflow will
execute the rename-project.bash and create Pull Request for you to review. Review the PR and merge.
Note: ideally this workflow would run automatically however due to a recent change github Actions are not enabled by default on newly created repos. There is no way to enable Actions other then to click the button in the UI. If this situation changes we will update this project so that the workflow is triggered during the bootstrap project. Further reading: https://github.saobby.my.eu.orgmunity/t/workflow-isnt-enabled-in-repos-generated-from-template/136421
Run the rename-project.bash and create a PR.
The rename-project.bash script takes a single argument - the name of the project and calculates from it the project description It then performs a search and replace and directory renames so the project is ready to be used.
To ensure notifications are routed to the correct slack channels, update the alerts-slack-channel and releases-slack-channel parameters in .circle/config.yml to an appropriate channel.
To allow easy identification of an application, the product Id of the overall product should be set in values.yaml. The Service Catalogue contains a list of these IDs and is currently in development here https://developer-portal.hmpps.service.justice.gov.uk/products
The easiest way to run the app is to use docker compose to create the service and all dependencies.
docker compose pull
docker compose up
The app requires:
- hmpps-auth - for authentication
- redis - session store and token caching
To start the main services excluding the example typescript template app:
docker compose up --scale=app=0
Install dependencies using npm install, ensuring you are using node v18.x and npm v9.x
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 CircleCI build config.
And then, to build the assets and start the app with nodemon:
npm run start:dev
npm run lint
npm run test
For local running, start a test db and 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 nodemon)
And then either, run tests in headless mode with:
npm run int-test
Or run tests with the cypress UI:
npm run int-test-ui
A changelog for the service is available here
The template project has implemented some scheduled checks to ensure that key dependencies are kept up to date.
If these are not desired in the cloned project, remove references to check_outdated job from .circleci/config.yml