@muvehealth/fixins/README.md

Component library for Muvehealth

# Muve Fixins
The front-end component library.

The Muve Fixins is a [Create React App][cra] built with
[styleguidist][styleguidist].

## Development Requirements
For development, you will need [Node.js][node] installed on your machine. A
[Current or LTS version of Node.js][lts] should do the trick and gets installed
through [homebrew][brew].

```sh
brew install node
```

This project prefers [yarn][yarn] over [npm][npm] as it's package manager. You
can also install [yarn][yarn] through [homebrew][brew].

```sh
brew install yarn
```

Yay package management.

## Development Setup
First, install the project dependencies:

```sh
yarn install
```

Normal [Create React App scripts][cra_scripts] are now available:

```sh
yarn flow  # Runs the Flow type checker
yarn lint  # Lints the project using eslint-config-muvehealth
yarn styleguide # Starts the development environment
yarn styleguide:build # Creates the production build
yarn test  # Runs the Jest test suite
```

View the [package.json](package.json) file for a list of dependencies and
configuration options. To learn more about a dependency use npm's `home` command:

```sh
npm home styled-system
```

<!-- Links -->
[brew]: https://brew.sh
[cra]: https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md
[cra_scripts]: https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#available-scripts
[lts]: https://github.com/nodejs/Release#nodejs-release-working-group
[node]: https://nodejs.org
[npm]: https://www.npmjs.com/get-npm
[yarn]: https://yarnpkg.com/en/
[styleguidist]: https://github.com/styleguidist/react-styleguidist