This is a web frontend for the Your Companies journey. It was created based on Typescript Web Starter for Companies House.
The documentation of the project is available on Confluence.
- node v20 (engines block in package.json is used to enforce this)
- 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 your-companies-web
npm install
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.
To allow connection to the app:
- Connect to the VPN
- Connect to AWS Servers
- Ensure Docker Desktop is open
To activate required modules and services:
- Locate to the
docker-chs-developmentdirectory in your console. - Run the following commands:
.bin/chs-dev modules enable platform
.bin.chs-dev development enable cdn-ch-gov-uk
.bin.chs-dev development enable your-companies-web
.bin.chs-dev services enable your-companies-web
To check required modules and services have been activated, run:
.bin/chs-dev status
If required, checkout the accounts-association-api branch, as this hasn't been merged with main yet, and contains the docker-compose.yaml file required for the application to run in Docker.
To start the application, run tilt up, and press 'space' to open tilt in your browser.
Wait for all the resources to finish updating successfully, making sure to re-run any with errors once others have finished.
To open open the application, in your browser, enter http://chs.local/your-companies.
To login to the application enter the email: [email protected], and password: password
To run the tests, type the following command:
npm test
To get a test coverage report, run:
npm run test:coverage