psc-extensions-web

This is a web frontend for the PSC Extensions journey. It was created based on Typescript Web Starter for Companies House.

Terraform ECS

What does this code do?

The code present in this repository is used to define and deploy a dockerised container in AWS ECS. This is done by calling a module from terraform-modules. Application specific attributes are injected and the service is then deployed using Terraform via the CICD platform 'Concourse'.

Application specific attributes	Value	Description
ECS Cluster	filing-maintain	ECS cluster (stack) the service belongs to
Load balancer	{env}-chs-chgovuk	The load balancer that sits in front of the service
Concourse pipeline	Pipeline link Pipeline code	Concourse pipeline link in shared services

Contributing

• Please refer to the ECS Development and Infrastructure Documentation for detailed information on the infrastructure being deployed.

Testing

• Ensure the terraform runner local plan executes without issues. For information on terraform runners please see the Terraform Runner Quickstart guide.
• If you encounter any issues or have questions, reach out to the team on the #platform slack channel.

Vault Configuration Updates

• Any secrets required for this service will be stored in Vault. For any updates to the Vault configuration, please consult with the #platform team and submit a workflow request.

Useful Links

• ECS service config dev repository
• ECS service config production repository

Frontend Technologies and Utils

• NodeJS
• ExpressJS
• Typescript
• NunJucks
• GOV.UK Design System
• Jest
• SuperTest
• Sonarqube
• Docker
• Git

Installing and Running

Requirements

1. node v20 (engines block in package.json is used to enforce this)
2. npm v10 (engines block in package.json is used to enforce this)

Having cloned the project into your project root, run the following commands:

cd psc-extensions-web

npm install

SSL set-up

If you wish to work with ssl-enabled endpoints locally, ensure you turn the NODE_SSL_ENABLED property to ON in the config and also provide paths to your private key and certificate.

Running Locally on Docker

1. Clone Docker CHS Development and follow the steps in the README

2. Enable the psc-extensions module

3. Run chs-dev up and wait for all services to start

To make local changes

Development mode is available for this service in Docker CHS Development.

./bin/chs-dev development enable psc-extensions-web

Environment variables used to configure this service in docker are located in the file services/modules/psc-extensions/psc-extensions-web.docker-compose.yaml

Running the tests

To run the tests, type the following command:

npm test

To get a test coverage report, run:

npm run coverage