GOV.UK Pay Self Service admin tool (Node.js)

• Pay CLI
• You have set up your local development environment

Start the backend services locally in docker, using the Pay CLI.

pay local up --cluster admin

Generate the environment variables file. This only needs to be done the first time you run locally.

./scripts/generate-dev-environment.sh local

Check that you are using the right version of Node, which should match what specified in package.json for engines/node.

node -v

If the node version is not what specified in package.json, then you need to install it and set it, e.g. for 22.14.0:

nvm install 22.14.0
nvm use
nvm alias default 22.14.0

Run the following in the project root to start the app:

npm i
npm run dev

Open the application in browser:

• http://127.0.0.1:3000

The local development server (npm run dev) will watch for any changes to files in the src directory and rebuild the bundles automatically.

Any changes to the server code will restart the app; changes to client side assets (SCSS/JS) and Nunjucks views will be reloaded automatically without a restart.

pay local up --cluster admin --mount-local-node-apps --local selfservice

This command will watch changes in your workspace and rebuild them in a Pay CLI managed selfservice task

npm run test

This command will run all mocha test suites matching the glob patterns *.test.js or *.test.ts

To run Cypress tests start the server in a separate terminal

npm run cypress:server

This runs both the Cypress server and @govuk-pay/run-amock which is the mock server used for stubbing out external API calls.

You can run Cypress tests headless or in a locally installed browser

npm run cypress:test # headless
npm run cypress:test-headed # in a browser

You can start the Cypress server with in-line source maps and auto reload enabled by running npm run cypress:dev-server. This will allow you to set breakpoints and step through the source when running a spec.

MIT License

GOV.UK Pay aims to stay secure for everyone. If you are a security researcher and have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner. Please refer to our vulnerability disclosure policy and our security.txt file for details.