# `@tribeplatform/react-ui-kit`

UI component library that is used to develop Tribe Community Platform


## Getting Started

1. Install the package.

```bash
$ yarn add @tribeplatform/react-ui-kit
```

1. Import the stylesheet into the porject entry files

```js
// App.js
import '@tribeplatform/react-ui-kit/styles'
```

### Webpack Users
If Webpack is unable to compile the project, try adding the [following option](https://webpack.js.org/configuration/module/#modulerules) to webpack configurations:

```js
webpackConfig.module.rules.push({
  test: /\.m?js$/,
  type: 'javascript/auto',
  resolve: {
    fullySpecified: false,
  },
})
```

This is a known issue with Webpack and build tools that wrap around Webpack, such as Create React App and Razzle.


## Contributing to the Project

Start the `storybook` with:

```bash
$ yarn dev
```