A Yeoman Generator for facebook's React framework and flux architecture using reflux.
- gulp
- grunt
- bower
- browserify
- reactify
- coffeescript
- compass
- jest
- reactjs
- reflux
- react-router
Install generator-react-reflux:
npm install -g generator-react-reflux
Make a new directory, and cd into it:
mkdir my-new-project && cd $_
Run yo react-reflux, optionally passing an app name:
yo react-reflux [app-name]
If selected install compass
gem install compass
Run gulp for building and gulp serve for preview
Available generators:
Note: Generators are to be run from the root directory of your app.
Sets up a new ReactJS app using the flux architecture implemented by reflux, generating all the boilerplate you need to get started.
Example:
yo react-refluxOptions:
-
--modernizrInclude Modernizr.
-
--coffee-scriptGenerate scripts in CoffeeScript.
-
--compassGenerate stylesheets in Compass.
-
--jestGenerate testing boilerplate with jest.
-
--build-tool=[grunt|gulp]Generate build config in the selected tool. Defaults to gulp.
-
--skip-installSkips the automatic execution of
bowerandnpmafter scaffolding has finished.
Generates a ReactJS component in app/scripts/components.
Example:
yo react-reflux:component dashboardOptions:
-
--coffee-scriptGenerate the component in CoffeeScript.
Running npm test will run the unit tests with mocha.
Recent changes can be viewed on Github on the Releases Page
See the contributing docs
When submitting an issue, please follow the guidelines. Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue.
When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
When submitting a new feature, add tests that cover the feature.
MIT