NHS prototype rig

Rapidly create HTML prototypes of NHS services.

Note

This project has been retired.

The NHS prototype rig was a re-imagined version of the NHS prototype kit. It added new features like asset compilation, feature flags and password protection.

This made sense while the NHS prototype kit wasn’t actively developed, but that situation later changed, and many of the features of this project were added to the official prototype kit package.

Requirements

• Node.js v20

Installation

1. Clone this repository:
   git clone git@github.com:x-govuk/nhsuk-prototype-rig.git

2. Install the dependencies:
   npm install

3. Start the application:
   npm start

You can change the service name by changing the prototype.serviceName value in package.json.

By default, the rig expects templates to use the .html file extension. You can change this by setting the prototype.templateExtension value in package.json.

Developing locally

To automatically refresh the browser upon updating a file, use npm run dev.

To lint JavaScript and CSS files, use npm run lint.

Releasing a new version

npm run release

This command will ask you what version you want to use. It will then publish a new version on NPM, create and push a new git tag and then generate release notes ready for posting on GitHub.

Note

Releasing a new version requires permission to publish packages to the @x-govuk organisation.

Contributing

If you’ve got an idea or suggestion, please create a GitHub issue.