/govuk-accessibility-sandbox

A place to build components that will have a public url so we can get them tested by the community.

Primary LanguageJavaScriptMIT LicenseMIT

GOV.UK Prototyping Kit

The kit provides a simple way to make interactive prototypes that look like pages on GOV.UK. These prototypes can be used to show ideas to people you work with, and to do user research.

It's built on the Express framework, and uses these GOV.UK resources:

Read the project principles.

Requirements

You may already have it, try:

node --version

Your version needs to be at least v0.10.0.

If you don't have Node, download it here: http://nodejs.org/.

Getting started

Install Node.js (see requirements)

Download the prototype kit

Download the zip file

Unzip the file

Install dependencies

Open a command line app (Terminal on OSX) and change to the unzipped directory. Then run:

npm install

This will install extra code that the prototype kit needs.

Run the app

node start.js

Go to localhost:3000 in your browser.

Hot reload

Any code changes should update in the browser without you restarting the app.

The app recompiles app/assets/stylesheets/application.scss everytime changes are observed.

Documentation

This project is built on top of Express, the idea is that it is straightforward to create simple static pages out of the box. However, you're not limited to that - more dynamic sites can be built with more understanding of Express. Here's a good Express tutorial.