# @cadolabs/sphere-ui &middot; <a target="_blank" href="https://github.com/Cado-Labs"><img src="https://github.com/Cado-Labs/cado-labs-logos/raw/main/cado_labs_badge.svg" alt="Supported by Cado Labs" style="max-width: 100%; height: 20px"></a> &middot; [![CI](https://github.com/Cado-Labs/sphere-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/Cado-Labs/sphere-ui/actions/workflows/ci.yml) &middot; [![npm version](https://badge.fury.io/js/@cadolabs%2Fsphere-ui.svg)](https://badge.fury.io/js/@cadolabs%2Fsphere-ui)

UI Kit for awesome applications 💅

Based on [PrimeReact](https://www.primefaces.org/primereact/).

## Install

```sh
npm i --save @cadolabs/sphere-ui
```

or

```sh
yarn add @cadolabs/sphere-ui
```

Include styles to your root `js` file:

```js
import "@cadolabs/sphere-ui/dist/index.css";
```

or root `css`, `scss` file:

```css
@import "~@cadolabs/sphere-ui/dist/index.css";
```

And require it for further usage
```js
import UI from "@cadolabs/sphere-ui"
```

---

## Storybook

navigate to storybook folder

```sh
cd storybook
```

install dependencies

```sh
yarn install
```

run

```sh
yarn storybook
```

build

```sh
yarn build-storybook
```

## Contributing

- Fork it ( https://github.com/Cado-Labs/sphere-ui )
- Create your feature branch (`git checkout -b feature/my-new-feature`)
- Commit your changes (`git commit -am '[feature_context] Add some feature'`)
- Push to the branch (`git push origin feature/my-new-feature`)
- Create a new Pull Request

## License

Released under MIT License.

## Supporting

<a href="https://github.com/Cado-Labs">
  <img src="https://github.com/Cado-Labs/cado-labs-resources/blob/main/cado_labs_supporting_rounded.svg" alt="Supported by Cado Labs" />
</a>

## Authors

[Aleksei Bespalov](https://github.com/nulldef)