Get started

Get up and running in minutes.

Like the GOV.UK Prototype Kit, the rig is built on the Express framework, and uses GOV.UK Frontend.

Requirements

• Node.js v18

Node version manager is recommended if you are working across multiple projects that use different versions of Node.js.

Downloading the Prototype Rig

There are few different ways you can get the rig:

• Download the Prototype Rig (zip)

• Visit the Prototype Rig GitHub repository and click ‘Use this template’.

  This will create a copy of the repository rather than a fork. This means you can start your project will a single commit, rather than the Prototype Rig’s commit history. Learn more about creating a repository from a template.

• In the terminal, clone the Prototype Rig GitHub repository:

  git clone git@github.com:x-govuk/govuk-prototype-rig.git
  

  Unlike using a template, this will include the commit history of the Prototype Rig.

Installation

1. Open the directory you downloaded the rig to

2. Install the dependencies: npm install

3. Start the application: npm start

4. Go to http://localhost:3000 in your browser.