Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chikara-chan/react-power
🔥 Command line toolkit includes full-featured scripts powered by React ecosystem.
https://github.com/chikara-chan/react-power
cli react utility
Last synced: about 2 months ago
JSON representation
🔥 Command line toolkit includes full-featured scripts powered by React ecosystem.
- Host: GitHub
- URL: https://github.com/chikara-chan/react-power
- Owner: chikara-chan
- License: mit
- Created: 2017-04-11T06:00:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-05-28T06:14:02.000Z (over 7 years ago)
- Last Synced: 2024-11-08T04:22:31.897Z (2 months ago)
- Topics: cli, react, utility
- Language: JavaScript
- Homepage:
- Size: 125 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
React Power
## Introduction
Command line toolkit includes full-featured scripts powered by React ecosystem.
Quickly start a web app development with none configuration, or optionally add a minimal config file when needed.
## Prerequisite
Requires Node.js v7.6 or later. (for async/await supporting)
## Getting Started
Creates a new work directory.
``` bash
$ mkdir my-app
$ cd my-app
```
Intalls react-power with npm or yarn.
``` bash
$ yarn init
$ yarn add --dev react-power
```
Adds scripts to package.json.
``` js
"scripts": {
"dev": "react-power dev",
"build": "react-power build",
"clean": "react-power clean"
}
```
Writes some source code.
``` bash
$ mkdir src
$ echo 'document.getElementById("root").innerHTML = "Hello world!"' > src/index.js
$ echo \
'
React Power
' \
> src/template.html
```
Tries running script `dev`, `build`, `clean`.
``` bash
$ yarn run dev
$ yarn run build
$ yarn run clean
```
## Configuration
Create a file `react-power.config.js` in root directory. In it, you'll configure like this:
``` js
module.exports = {
input: './src',
output: './dist',
publicPath: '/',
multi: false,
ignore: /shared/,
vendor: [],
externals: {},
babelrc: {},
rules: [],
browserslist: ['last 2 versions', '> 5%', 'ie > 8'],
cssModules: true,
hot: true,
hash: true,
host: 'localhost',
port: 3000,
open: false
}
```
## Options Reference
Option | Type | Default | Description
--- | --- | --- | ---
input | String | './src' | Where react-power resolve source code.
output | String | './dist' | Where react-power output bundles.
publicPath | String | '/' | Specifies the public URL of the output directory when referenced in a browser.
multi | Boolean | false | Whether is a multi page application or not.
ignore | RegExp | /shared/ | Ignores the module name using regexp only effective when multi is true.
vendor | Array | | Specifies the vendor modules to make them seperate from main bundle.
externals | Object | | Provides a way of excluding dependencies from the output bundles.
babelrc | Object | | Extends built-in babel transforming configuration.
rules | Array | | Extends built-in loader rules configuration.
browserslist | Array | ['last 2 versions', '> 5%', 'ie > 8'] | Declare supported environments by performing queries both applied to js and css.
cssModules | Boolean | true | Whether enables css modules or not.
hot | Boolean | true | Whether enables hot module replacement or not.
hash | Boolean | true | Whether enables hash and chunkhash bundles or not.
host | String | 'localhost' | Local development server host.
port | Number | 3000 | Local development server port.
open | Boolean | false | Whether open the browser immediately when bundles are finished.
## Buit-in Features
**babelrc**
- `babel-preset-env`
- `babel-preset-stage-0`
- `babel-preset-react`
- `react-hot-loader/babel`
- `babel-plugin-transform-runtime`
**rules**
- `babel-loader`
- `json-loader`
- `sass-loader`
- `less-loader`
- `url-loader`
## Examples
See more examples for usage detail.
- [basic](https://github.com/chikara-chan/react-power/tree/master/examples/0-basic)
- [multi](https://github.com/chikara-chan/react-power/tree/master/examples/1-multi)
- [spa](https://github.com/chikara-chan/react-power/tree/master/examples/2-spa)
- [complex](https://github.com/chikara-chan/react-power/tree/master/examples/3-complex)
## License
Released under the [MIT](https://github.com/chikara-chan/react-power/blob/master/LICENSE) license.