react-native-contrib/rsx

View on GitHub
README.md

Summary

Maintainability
Test Coverage
![rsx logo](http://react-native-contrib.github.io/rsx/images/logo.png)

[![npm version][ico-npm]][link-npm]
[![License][ico-license]](LICENSE.md)
[![Travis CI][ico-travis]][link-travis]
[![Code Climate][ico-codeclimate]][link-codeclimate]
[![Code Coverage][ico-code-coverage]][link-code-coverage]
[![Dependencies][ico-dependencies]][link-dependencies]

---

**React Starter GearboX** - a CLI tool built to ease your daily React Native development.

## Rationale

Inspired by the `cordova` tool and motivated by the, uhh, *interesting* API of the `react-native` CLI tool. Big shoutouts and love to the `rnpm` and `react-native` peepz, a lot of the code is cribbed from them.

`rsx` aims to one day completely replace the `react-native` CLI tool, leaving the core team to focus on more cooler things :smile:.

## Requirements

- node >= 4.1

## Installation

```bash
$ npm install -g rsx
```

> If you receive an `EACCES: permission denied` error, please [fix NPM's permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) (bit of a running gag now).

## Documentation

All documentation is available at this project's [GitHub pages](http://react-native-contrib.github.io/rsx/).

## Plugins

### Common

| Name | Version | Status | Coverage |
|---|---|---|---|
| [rsx-common][link-github-rsx-common] | [![npm version][ico-npm-rsx-common]][link-npm-rsx-common] | [![Travis CI][ico-travis-rsx-common]][link-travis-rsx-common] | [![Code Coverage][ico-code-coverage-rsx-common]][link-code-coverage-rsx-common] |

### Core
| Name | Version | Status | Coverage
|---|---|---|---|
| [rsx-plugin-new][link-github-rsx-new] | [![npm version][ico-npm-rsx-new]][link-npm-rsx-new] | [![Travis CI][ico-travis-rsx-new]][link-travis-rsx-new] | [![Code Coverage][ico-code-coverage-rsx-new]][link-code-coverage-rsx-new] |
| [rsx-plugin-platforms][link-github-rsx-platforms] | [![npm version][ico-npm-rsx-platforms]][link-npm-rsx-platforms] | [![Travis CI][ico-travis-rsx-platforms]][link-travis-rsx-platforms] | [![Code Coverage][ico-code-coverage-rsx-platforms]][link-code-coverage-rsx-platforms] |
| [rsx-plugin-plugins][link-github-rsx-plugins] | [![npm version][ico-npm-rsx-plugins]][link-npm-rsx-plugins] | [![Travis CI][ico-travis-rsx-plugins]][link-travis-rsx-plugins] | [![Code Coverage][ico-code-coverage-rsx-plugins]][link-code-coverage-rsx-plugins] |
| [rsx-plugin-run][link-github-rsx-run] | [![npm version][ico-npm-rsx-run]][link-npm-rsx-run] | [![Travis CI][ico-travis-rsx-run]][link-travis-rsx-run] | [![Code Coverage][ico-code-coverage-rsx-run]][link-code-coverage-rsx-run] |
| [rsx-plugin-status][link-github-rsx-status] | [![npm version][ico-npm-rsx-status]][link-npm-rsx-status] | [![Travis CI][ico-travis-rsx-status]][link-travis-rsx-status] | [![Code Coverage][ico-code-coverage-rsx-status]][link-code-coverage-rsx-status] |


### Addons

| Name | Version | Status | Coverage |
|---|---|---|---|
|  |  |  |  |

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[link-github-rsx-common]: https://github.com/react-native-contrib/rsx-common
[ico-npm-rsx-common]: https://img.shields.io/npm/v/rsx-common.svg?style=flat-square
[link-npm-rsx-common]: https://www.npmjs.com/package/rsx-common
[ico-travis-rsx-common]: https://img.shields.io/travis/react-native-contrib/rsx-common/master.svg?style=flat-square
[link-travis-rsx-common]: https://travis-ci.org/react-native-contrib/rsx-common
[ico-code-coverage-rsx-common]: https://img.shields.io/codeclimate/coverage/github/react-native-contrib/rsx-common.svg?style=flat-square
[link-code-coverage-rsx-common]: https://codeclimate.com/github/react-native-contrib/rsx-common/coverage

[link-github-rsx-new]: https://github.com/react-native-contrib/rsx-plugin-new
[ico-npm-rsx-new]: https://img.shields.io/npm/v/rsx-plugin-new.svg?style=flat-square
[link-npm-rsx-new]: https://www.npmjs.com/package/rsx-plugin-new
[ico-travis-rsx-new]: https://img.shields.io/travis/react-native-contrib/rsx-plugin-new/master.svg?style=flat-square
[link-travis-rsx-new]: https://travis-ci.org/react-native-contrib/rsx-plugin-new
[ico-code-coverage-rsx-new]: https://img.shields.io/codeclimate/coverage/github/react-native-contrib/rsx-plugin-new.svg?style=flat-square
[link-code-coverage-rsx-new]: https://codeclimate.com/github/react-native-contrib/rsx-plugin-new/coverage

[link-github-rsx-platforms]: https://github.com/react-native-contrib/rsx-plugin-platforms
[ico-npm-rsx-platforms]: https://img.shields.io/npm/v/rsx-plugin-platforms.svg?style=flat-square
[link-npm-rsx-platforms]: https://www.npmjs.com/package/rsx-plugin-platforms
[ico-travis-rsx-platforms]: https://img.shields.io/travis/react-native-contrib/rsx-plugin-platforms/master.svg?style=flat-square
[link-travis-rsx-platforms]: https://travis-ci.org/react-native-contrib/rsx-plugin-platforms
[ico-code-coverage-rsx-platforms]: https://img.shields.io/codeclimate/coverage/github/react-native-contrib/rsx-plugin-platforms.svg?style=flat-square
[link-code-coverage-rsx-platforms]: https://codeclimate.com/github/react-native-contrib/rsx-plugin-platforms/coverage

[link-github-rsx-plugins]: https://github.com/react-native-contrib/rsx-plugin-plugins
[ico-npm-rsx-plugins]: https://img.shields.io/npm/v/rsx-plugin-plugins.svg?style=flat-square
[link-npm-rsx-plugins]: https://www.npmjs.com/package/rsx-plugin-plugins
[ico-travis-rsx-plugins]: https://img.shields.io/travis/react-native-contrib/rsx-plugin-plugins/master.svg?style=flat-square
[link-travis-rsx-plugins]: https://travis-ci.org/react-native-contrib/rsx-plugin-plugins
[ico-code-coverage-rsx-plugins]: https://img.shields.io/codeclimate/coverage/github/react-native-contrib/rsx-plugin-plugins.svg?style=flat-square
[link-code-coverage-rsx-plugins]: https://codeclimate.com/github/react-native-contrib/rsx-plugin-plugins/coverage

[link-github-rsx-run]: https://github.com/react-native-contrib/rsx-plugin-run
[ico-npm-rsx-run]: https://img.shields.io/npm/v/rsx-plugin-run.svg?style=flat-square
[link-npm-rsx-run]: https://www.npmjs.com/package/rsx-plugin-run
[ico-travis-rsx-run]: https://img.shields.io/travis/react-native-contrib/rsx-plugin-run/master.svg?style=flat-square
[link-travis-rsx-run]: https://travis-ci.org/react-native-contrib/rsx-plugin-run
[ico-code-coverage-rsx-run]: https://img.shields.io/codeclimate/coverage/github/react-native-contrib/rsx-plugin-run.svg?style=flat-square
[link-code-coverage-rsx-run]: https://codeclimate.com/github/react-native-contrib/rsx-plugin-run/coverage

[link-github-rsx-status]: https://github.com/react-native-contrib/rsx-plugin-status
[ico-npm-rsx-status]: https://img.shields.io/npm/v/rsx-plugin-status.svg?style=flat-square
[link-npm-rsx-status]: https://www.npmjs.com/package/rsx-plugin-status
[ico-travis-rsx-status]: https://img.shields.io/travis/react-native-contrib/rsx-plugin-status/master.svg?style=flat-square
[link-travis-rsx-status]: https://travis-ci.org/react-native-contrib/rsx-plugin-status
[ico-code-coverage-rsx-status]: https://img.shields.io/codeclimate/coverage/github/react-native-contrib/rsx-plugin-status.svg?style=flat-square
[link-code-coverage-rsx-status]: https://codeclimate.com/github/react-native-contrib/rsx-plugin-status/coverage

[ico-npm]: https://img.shields.io/npm/v/rsx.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/react-native-contrib/rsx/master.svg?style=flat-square
[ico-codeclimate]: https://img.shields.io/codeclimate/github/react-native-contrib/rsx.svg?style=flat-square
[ico-code-coverage]: https://img.shields.io/codeclimate/coverage/github/react-native-contrib/rsx.svg?style=flat-square
[ico-dependencies]: https://img.shields.io/david/react-native-contrib/rsx.svg?style=flat-square

[link-npm]: https://www.npmjs.com/package/rsx
[link-travis]: https://travis-ci.org/react-native-contrib/rsx
[link-codeclimate]: https://codeclimate.com/github/react-native-contrib/rsx
[link-code-coverage]: https://codeclimate.com/github/react-native-contrib/rsx/coverage
[link-dependencies]: https://david-dm.org/react-native-contrib/rsx