Skip to content

Commit ab2b166

Browse files
Update documentation to include running locally
1 parent f5a3637 commit ab2b166

2 files changed

Lines changed: 29 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ This repository contains the code for NHS.UK React components - a port of the [N
88

99
[View documentation and examples](https://nhsdigital.github.io/nhsuk-react-components)
1010

11-
## Installation
11+
## Install package
1212

13-
You can install this package using either `npm` or `yarn`.
13+
You can install this package into your service using either `npm` or `yarn`.
1414

1515
```bash
1616
npm install --save nhsuk-react-components
@@ -41,6 +41,30 @@ import { DateInput, Form } from 'nhsuk-react-components';
4141
</Form>;
4242
```
4343

44+
## Development
45+
46+
To run this project locally, set up Yarn using [Node.js corepack](https://github.com/nodejs/corepack#readme)
47+
48+
```bash
49+
npm install -g corepack
50+
corepack enable
51+
yarn install
52+
```
53+
54+
Then run the following:
55+
56+
1. **Build and watch package**
57+
58+
```bash
59+
yarn build --watch
60+
```
61+
62+
2. **Open documentation and examples**
63+
64+
```bash
65+
yarn storybook
66+
```
67+
4468
## Upgrading
4569

4670
- [Upgrading to 1.0](/docs/upgrade-to-1.0.md)

‎stories/Welcome.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ NHS.UK Frontend ported to React
99
[![CD Build and Publish to NPM](https://github.com/NHSDigital/nhsuk-react-components/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/NHSDigital/nhsuk-react-components/actions/workflows/release.yml)
1010
[![Bundle Size](https://img.shields.io/bundlephobia/minzip/nhsuk-react-components.svg)](https://bundlephobia.com/result?p=nhsuk-react-components)
1111

12-
## Installation
12+
## Install package
1313

14-
You can install this package using either `yarn` or `npm`.
14+
You can install this package into your service using either `npm` or `yarn`.
1515

1616
```bash
1717
npm install --save nhsuk-react-components
18+
1819
# Or
1920
yarn add nhsuk-react-components
2021
```

0 commit comments

Comments
 (0)