Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 2.24 KB

README.md

File metadata and controls

77 lines (54 loc) · 2.24 KB
Raw

generator-react-rocket Build Status npm version

A Yeoman generator to bootstrap a React/Flux application powered by Gulp! 🚀

Features

  • Flux directory structure
  • Build with Gulp
    • Compile React (JSX) components (with Babel)
    • Handle CommonJS dependencies with Webpack
    • ES6 to ES5 (with Babel)
    • Lint JS and JSX code with JSHint
    • Compile sass stylesheets
    • Browser sync
    • Uglify javascript with UglifyJS
    • Minify css with gulp-minify-css
    • Build for Production with --production
    • Preprocess javascript with gulp-preprocess
  • Components testing with Karma
  • Component sub-generator

Getting Started

Install

npm install -g yo
npm install -g generator-react-rocket

Usage

mkdir myapp && cd myapp
yo react-rocket

Gulp tasks

  • gulp or gulp serve to start a developement web server with live reload (supports the --production flag)
  • gulp build to build the app in dist/ directory (supports the --production flag)
  • gulp clean to clean up dist/ directory

react-rocket:component

Generates a JSX component class in src/scripts/components and the associated test file in src/scripts/components/__tests__

yo react-rocket:component

Run your tests (with Karma)

npm test

Future improvements

  • More/better tests
  • More sub-generators

See also

Rocket, a Rails API application template.

License

MIT

Contributing

  1. Fork it ( https://github.com/nsarno/generator-react-rocket/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request