open-index/open-npm huggingface dataset:
npm package: @earn-up/components-system
Description: EarnUp Component Library
Author: EarnUp
Latest version: 0.1.0-alpha.77

&copy; EarnUp 2018

# Components System

This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). For more information, see the original [README](CreateReactApp.md).

## Useful Links
- [Debugging in the Editor](CreateReactApp.md#debugging-in-the-editor)


## Getting Started
To get started, all you'll need to do is install the NPM packages using:

```shell
npm install
```

After the NPM packages are installed, run a local development server using:

```shell
npm start
```

## Documentation
This library leverages [Styleguidist](https://react-styleguidist.js.org/) for generating React component documentation. To view documentation for your current branch, issue the following command:

```shell
# Aliased in package.json
npm run docs
```

**Note:** This requires [npx](https://github.com/zkat/npx).

This will start up a local documentation server after compilation. Navigate to the `localhost` endpoint to see the documentation.

The documentation server is equipped with hot reloading, however it will not update when either the [config](styleguide.config.js) or the [styles](styleguide.styles.js) are updated.

### Adding Component Documentation
Follow the patterns found in the [styleguide config file](styleguide.config.js) for adding components and sections to the styleguide.

**Note:** the documenation server is equipped with hot reload, but it will not respond to config changes.

## Contributions and Reviews
Because this repository will be used across our applications, code owners have been assigned to ensure these components are added only as necessary, without duplication, and to ensure consistency.

All pull requests must be complete with Styleguidist documentation, and reviewers should begin with documentation before code review to ensure that components are up to specifications.