# neo-ui

`neo-ui` is a [React](https://facebook.github.io/react/) UI Framework built to conform Club Freelance new website UI.
## Setup

* Install with `npm` or `yarn`:
```sh
npm i neo-ui
# OR
yarn add neo-ui
```
* Use in your project:

```jsx
import React from 'react';
import { Button } from 'neo-ui';

const App = () => (
    <Button>
      Hello World!
    </Button>
);
```
## Develop components with Storybook
### Get storybook up and running
in order to start seeing the components run Storybook:
```sh
npm run dev
```
Open http://localhost:9009/ in your favorite web browser.
### Create new component
`npm run create-component`: This command scaffold a component directory with our component boilerplate.
You can use it as follow:
```
npm run create-component test-component TestComponent
```

### Component folders structure explained
Every component folder will have the following structure
 ```
 /test-component/
 ├── /src/
 ├── /stories/
 ├── /test/
 └── index.js
 ```
 - The `src` folder contains `.jsx` files that represent the implementation of the component.
 - The `stories` folder contains the stories of the component. To be automatically added to the storybook menu, your stories file must follow the regEx pattern of `*.stories.js`.
 - The `test` folder contains unit tests of the component. We use [jest](https://jestjs.io/) along with [Enzyme](https://airbnb.io/enzyme/) to create unit tests.