<h1 align="center">@deriv/components</h1>

@deriv/components is a UI component library made for ReactJS that conforms to the [Deriv Design System](https://zeroheight.com/36313d3c8/p/439a5c-deriv-design-system). Check out our [Storybook](deriv-components.binary.sx/) for development documentation.

![vercel deployment](https://img.shields.io/github/deployments/binary-com/deriv-components/production?label=vercel%20) ![npm version](https://img.shields.io/npm/v/@deriv/components) ![npm downloads](https://img.shields.io/npm/dt/@deriv/components) ![commit activity](https://img.shields.io/github/commit-activity/m/binary-com/deriv-components) ![follow github](https://img.shields.io/github/stars/binary-com/deriv-components?style=social)

## Usage

To use @deriv/components in your project, add it as a dependency:

```sh
npm i @deriv/components
```

## Development

To get started, first install all of the relevant packages by doing:

```sh
npm i
```

This projects uses Storybook to showcase the components. You can serve the components by adding a stories component. See Implementation Guide. To start serving Storybook, simply run:

```sh
npm start
```
