Skip to content

A web application for the Authorised Corporate Service Providers (ACSP)

License

Notifications You must be signed in to change notification settings

companieshouse/acsp-web

Repository files navigation

acsp-web

This is a web frontend for the Authorized Corporate Service Providers (ACSP). It was created based on Typescript Web Starter for Companies House.

The documentation of the project is available on Confluence.

Frontend technologies and utils

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 acsp-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 the app locally

To start the application, run:

npm start

or, to watch for changes with auto restart in your dev environment, run:

npm run start:watch

...and navigate to http://localhost:3000/ (or whatever hostname/port number combination you've changed the config values to)

For SSL connections, navigate to https://localhost:3443

Running the tests

To run the tests, type the following command:

npm test

To get a test coverage report, run:

npm run test:coverage