Install the kit

Download the kit as a zip

The simplest way to get the kit is to download it as a zip.

You'll use a new copy of the kit for each new prototype you make. That way your prototypes don’t interfere with each other.

Make sure you are installing the kit on a local drive. Do not install the kit on a cloud-based drive (for example, Dropbox, Microsoft OneDrive), as this may cause permissions issues.

Make a folder for your prototypes

We recommend keeping all your prototypes in one folder called prototypes.

Create a folder called prototypes in your Documents folder.

Unzip the kit and move it

Unzip the kit you downloaded - you should end up with a folder called govuk-prototype-kit followed by the version number.

Rename the folder to something descriptive for your prototype. For this guide, we’ll use juggling-licence.

Move the folder into your prototypes folder.

Terminal basics

The terminal (on Mac and Linux, git bash on Windows) lets you type in commands and run programs on your computer. You can also use it to browse your file system, for example to open folders.

You can follow a tutorial on basic terminal commands on the codebar website.

You need to navigate to your prototype folder in the terminal. Most commands for the kit need to be run in the prototype folder.

cd ~/Documents/prototypes/juggling-licence

Take note of what is upper or lower case - for example lower case 'd' for 'Documents' will not work.

If any of your folder names contain spaces, you must add quotation marks around everything after ~/. For example:

cd ~/"a folder name with spaces/Documents/prototypes/juggling-licence"

Install modules

You need to download extra code used by the kit before it can run. You only need to run this command the first time you start or download a prototype:

npm install

The install may take about a minute. Whilst installing, it may WARN about some items - this is ok. As long as there are no ERRORs, you can continue.

Next (run the kit)