okp4/ui

import { Meta } from '@storybook/addon-docs'
import './main.scss'

<Meta title="Getting started" />

# Getting started

The OKP4 Design System contains a collection of [React](https://reactjs.org) components that can be used to build accessible and performant React applications
consistent with [OKP4](https://okp4.network) brand guidelines.

## Prerequisite

To build and run the project, be sure to have the following items properly installed:

- [NodeJS](https://nodejs.org/en/download/) `^16.14.0`
- [NPM](https://www.npmjs.com/get-npm)
- [yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable) `~1.22.17`

## Build

To build the `@okp4/ui` library, type the following command:

```sh
yarn && yarn build
```

You can also start Storybook and start editing the code in live:

```sh
yarn storybook
```

### Use

To get started using `@okp4/ui` first add or install the module to your existing React project using either `yarn` or `npm`.

```sh
yarn add @okp4/ui
```

or

```sh
npm install --save @okp4/ui
```