README.md

ONS Prototype Kit

A prototyping kit that uses the ONS Design System (GitHub).

Using this prototype kit

Prerequisites

You'll need Git, Node.js, and Yarn to run this project locally.

The version of node required is outlined in .nvmrc.

Local git configuration

Make sure your local git configuration is set up to use main as the default branch when initialising a new repository.

git config --global init.defaultBranch main

Creating a prototype kit project

1. Create a new repository for your prototypes using the prototype-kit template on GitHub

2. Clone the code of your new repository to a new folder on your device, so you can start building your prototypes.

3. Install the latest version of the design system:

   In the terminal:

   yarn add @ons/design-system

4. Review README for further information on how to use the new prototype-kit project.

Using nvm (optional)

If you work across multiple Node.js projects there's a good chance they require different Node.js and npm versions.

To enable this we use nvm (Node Version Manager) to switch between versions easily.

1. install nvm
2. Run nvm install in the project directory (this will use .nvmrc)

Windows users

The nvm listed above is only for Mac/Linux users. A separate version of nvm is available for Windows here: https://github.com/coreybutler/nvm-windows

Install dependencies

yarn install

Release Process

To make changes available to be used in prototype repos you will need to create a new github tag. To do this in the command line run:

git tag <tag-name>
git push origin --tags

Then in the repo that uses the prototype kit this will need to be updated to reflect that new tag.