# flux-module-reports

[![Maintainability](https://api.codeclimate.com/v1/badges/40c4f2c4e9ef9df6c270/maintainability)](https://codeclimate.com/github/tiarebalbi/flux-module-reports/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/40c4f2c4e9ef9df6c270/test_coverage)](https://codeclimate.com/github/tiarebalbi/flux-module-reports/test_coverage)
[![Build Status](https://travis-ci.org/tiarebalbi/flux-module-reports.svg?branch=master)](https://travis-ci.org/tiarebalbi/flux-module-reports)
![npm (scoped)](https://img.shields.io/npm/v/@tiarebalbi/flux-module-reports.svg)
[![](https://data.jsdelivr.com/v1/package/npm/@tiarebalbi/flux-module-reports/badge)](https://www.jsdelivr.com/package/npm/@tiarebalbi/flux-module-reports)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
----

| Platform       | Details                                    |
| -------------- |:------------------------------------------:|
| Install        | `yarn add @tiarebalbi/flux-module-reports` |
| npm            | `@tiarebalbi/flux-module-reports`          |
| Bundle         | [unpkg.com](https://unpkg.com/@tiarebalbi/flux-module-reports)  |
| CDN            | [jsdelivr.com](https://www.jsdelivr.com/package/npm/@tiarebalbi/flux-module-reports)  |

## Summary

Sample application using the concept of code splitting and this repository will hold all packages used in the
main sample [flux-main-sample](https://github.com/tiarebalbi/flux-main-sample).

## What do I need to get started?

- [Node](https://nodejs.org/en/download/) (version 7 or later)
- [Yarn](https://yarnpkg.com/lang/en/docs/install/)

## What's in the box?

- [Flowtype](https://flowtype.org/) Type checker
- [React](https://facebook.github.io/react/) User interface components
- [Flux](http://facebook.github.io/flux/) Application Architecture For Building User Interfaces
- [Babel](https://babeljs.io/) JavaScript transpiler
- [ESLint](http://eslint.org/) JavaScript Linter
- [Prettier](https://github.com/prettier/prettier) Code formatter
- [Jest](https://facebook.github.io/jest/) Testing solution

## How do I use this?

You can find our documentation [here](./docs/README.md).

## Usage

### Install dependencies

Install the project dependencies using Yarn.

```bash
yarn
```

### Distribution build

You can compile the distribution build with the `build` script.

```bash
yarn build
```
## Test

### Test suite

You can run the test suite with the `test` script.

```bash
yarn test
```

## License

[Apache-2](LICENSE)