Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robeio/robe-react-commons

Last synced: 3 days ago
JSON representation

Host: GitHub
URL: https://github.com/robeio/robe-react-commons
Owner: robeio
License: mit
Created: 2016-06-07T06:12:30.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2017-04-10T13:26:21.000Z (over 7 years ago)
Last Synced: 2024-09-21T12:24:09.218Z (about 2 months ago)
Language: JavaScript
Size: 347 KB
Stars: 8
Watchers: 4
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Robe-React-Commons

#### A complete commons library especially for react projects.  

[![npm package](https://badge.fury.io/js/robe-react-commons.svg)](https://badge.fury.io/js/robe-react-commons)

[![Build Status](https://travis-ci.org/robeio/robe-react-commons.svg?branch=master)](https://travis-ci.org/robeio/robe-react-commons)

[![codecov](https://codecov.io/gh/robeio/robe-react-commons/branch/master/graph/badge.svg)](https://codecov.io/gh/robeio/robe-react-commons)

[![dependencies](https://www.versioneye.com/user/projects/57839ae176ef40003fba80f6/badge.svg)](https://www.versioneye.com/user/projects/57839ae176ef40003fba80f6?child=summary)

RRC = Robe-React-Commons

##### Motivation

Aims to be a complete solution for our common project needs. All coded with ES6 syntax.

##### What's inside

* [Webpack](https://webpack.github.io/) for all development (server,hotload etc.) and build (package, optimize, etc.) needs.

* [Babel](https://babeljs.io/flow) for writing codes with ES6 syntax and transpiling them browser compatible codes. 

* [ESLint](http://eslint.org/) for protecting our nice formatted codes.

* [Flow](http://flowtype.org/) for type checking.

* [Karma](https://karma-runner.github.io/0.13/index.html) for running tests.

* [Chai](http://chaijs.com/) for asserting test errors.

* [Isparta](https://github.com/douglasduteil/isparta) for ES6 code coverage.

* [Istanbul](https://github.com/gotwarlost/istanbul) for code coveragereporting.

* [React](https://facebook.github.io/react/) for ui components.

### Quick Start

#### How to use

Go to your project folder

```shell

npm install robe-react-commons --save-dev

```

You can import this project in 2 ways.

1. Partial import. For ex. `import Maps from "robe-react-commons/lib/utils/Maps";`

2. All-in-one, minified, optimized single js. For ex. **TODO: example coming soon.**

#### How to contribute

Clone and run `npm install`. This will install both run-time project dependencies and developer tools listed

in [package.json](./package.json) file.

#### How to Build for Production

If you need just to build the app (without running a dev server), simply run:

```shell

$ npm run-script build

```

 

####  How to run Unit Tests.

```shell

$ npm testnpm

```