README.md

BEIS SPL Planner

This repository contains the code for the Shared Parental Leave (SPL) and Stautory Shared Parental Pay (ShPP) planner service.

It is built on top of the BEIS SPL common baseline project, which in turn is forked from the GDS Node.js boilerplate project.

## Architecture The application is is purely frontend. There is no backend, no database. An example architecture diagram can be seen in the root folder.

Getting started on development

Installs

Required

• Git
• Node

Recommended

• Visual Studio Code and these extensions:
  • Nunjucks VSCode Extension Pack
  • EditorConfig for VSCode
  • StandardJS - JavaScript Standard Style
• LiveReload browser extension

Set up

Clone this code with Git:

git clone [email protected]:UKGovernmentBEIS/beis-spl-planner.git

Add the common project as a second remote in Git, to pull changes from there when needed:

git remote add common [email protected]:UKGovernmentBEIS/beis-spl-common.git
git fetch common

Navigate to the root of the project and install NPM packages:

npm install

Running the project in development

Once NPM packages have been installed, run the project locally with:

npm run dev

You should now be able to see the project running at http://localhost:3000/ in your browser.

If you have installed the LiveReload browser extension as above, then you can enable it once on the page. This will cause the page to automatically reload when you make changes to any file.

Running Playwright tests

This configuration of Playwright runs tests in parallel.

• Run npx playwright install to setup browsers and playwright dependencies
• Use npm run test:feature or npx playwright test to run tests
  • Add a --ui flag to the command to use Playwright GUI