Yeoman generator for ReactJS - lets you quickly set up a project including karma test runner and Webpack module system.
Install generator-react-webpack:
npm install -g generator-react-webpack
Make a new directory, and cd into it:
mkdir my-new-project && cd $_
Run yo react-webpack, optionally passing an app name:
yo react-webpack [app-name]
Run grunt build for building and grunt serve for preview in the browser at localhost.
Available generators:
and for Flux or Reflux :
Sets up a new ReactJS app, generating all the boilerplate you need to get started. The app generator also facilitates the following:
- Configures a Gruntfile to run the app on a local server.
- Configures Webpack to modularise the app enabling loading of various file formats e.g. JSON, CSS, PNG, etc.
- Configures Karma to run all tests.
- Watches for changes and recompiles JS and refreshes the browser.
Example:
yo react-webpackGenerates a JSX component in src/scripts/components, its corresponding test in src/spec/components and its style in src/style.
Example:
yo react-webpack:component foo //or just: yo react-webpack:c fooProduces src/components/Foo.js (javascript - JSX):
'use strict';
var React = require('react/addons');
require('styles/componentName.css'); //or .sass,.less etc...
var Foo = React.createClass({
render: function () {
return (
<div>
<p>Content for Foo</p>
</div>
)
}
});
module.exports = Foo;
And test/spec/components/Foo.js (javascript - jasmine):
'use strict';
describe('Foo', function () {
var Foo, component;
beforeEach(function () {
Foo = require('../../../src/components/Foo');
component = Foo();
});
it('should create a new instance of Foo', function () {
expect(component).toBeDefined();
});
});
And src/styles/Foo.css (or .sass, .less etc...) :
.Foo{
border: 1px dashed #f00;
}
For all you lazy programmers out there, we've added another shortcut - rich flag:
yo react-webpack:c foofoo --rich This will give you all of react component's most common stuff :
var React = require('react/addons');
require('styles/Foofoo.sass');
var Foofoo = React.createClass({
mixins: [],
getInitialState: function() { return({}) },
getDefaultProps: function() {},
componentWillMount: function() {},
componentDidMount: function() {},
shouldComponentUpdate: function() {},
componentDidUpdate: function() {},
componentWillUnmount: function() {},
render: function () {
return (
<div>
<p>Content for Foofoo</p>
</div>
);
}
});
module.exports = Foofoo;
Just remove those you don't need, then fill and space out the rest.
When using Flux or Reflux architecture, it generates an actionCreator in src/actions and it's corresponding test in src/spec/actions.
Example:
yo react-webpack:action bar //or just: yo react-webpack:a barWill create a file - src/actions/BarActionCreators.js
if 'architecture' is Flux, it Produces :
'use strict';
var BarActionCreators = {
}
module.exports = BarActionCreators;
And if it's Reflux:
'use strict';
var Reflux = require('reflux');
var BarActionCreators = Reflux.createActions([
]);
module.exports = BarActionCreators;
and same test for both architectures:
'use strict';
describe('BarActionCreators', function() {
var action;
beforeEach(function() {
action = require('actions/BarActionCreators.js');
});
it('should be defined', function() {
expect(action).toBeDefined();
});
});
When using Flux or Reflux architecture, it generates a store in src/stores and it's corresponding test in src/spec/stores.
Example:
yo react-webpack:store baz //or just: yo react-webpack:s bazWill create a file - src/stores/BazStore.js
if 'architecture' is Flux, it Produces :
'use strict';
var EventEmitter = require('events').EventEmitter;
var assign = require('object-assign');
var MainAppDispatcher = require('../dispatcher/MainAppDispatcher');
var BazStore = assign({}, EventEmitter.prototype, {
});
BazStore.dispatchToken = MainAppDispatcher.register(function(action) {
switch(action.type) {
default:
}
});
module.exports = BazStore;
And if it's Reflux:
'use strict';
var Reflux = require('reflux');
//var Actions = require('actions/..');
var BazStore = Reflux.createStore({
listenables: Actions,
});
module.exports = BazStore;
and same test for both architectures:
'use strict';
describe('BazStore', function() {
var store;
beforeEach(function() {
store = require('stores/BazStore.js');
});
it('should be defined', function() {
expect(store).toBeDefined();
});
});
Options are available as additional installs to the initial application generation phase.
A complete routing library for React. This option only adds the basic hooks to get started with react router.
css, sass, scss, less or stylus
Sets the style file's template and extension
If you are using es6, and want to use its export functionality (and not webpack's), just add --es6 flag when you create a component, action or srore.
Running grunt test will run the unit tests with karma. Tests are written using Jasmine by default.
The react-webpack generator automates the setup of a ReactJS project using the specific structure detailed below:
project
- src
-components
MainApp.js
Foo.js
AnotherComponent.js
//for flux/reflux
-actions
BarActionCreators.js
-stores
BazStore.js
//for flux
-dispatcher
FooAppDispatcher
- styles
main.css
index.html
- test
- spec
- components
MainApp.js
Foo.js
AnotherComponent.js
//for flux/reflux
-actions
BarActionCreators.js
-stores
BazStore.js
- helpers
- react
addons.js
phantomjs-shims.js
Gruntfile.js
karma.conf.js
package.json
webpack.config.js
webpack.dist.config.js
I have tried to keep the project structure as simple as possible and understand it may not suit everyone.
I have opted to follow @floydophone convention of uppercase for component file naming e.g. Component.js. I am open to suggestions if there is a general objection to this decision.
Each component is a module and can be required using the Webpack module system. Webpack uses Loaders which means you can also require CSS and a host of other file types. Read the Webpack documentation to find out more.
Out the box the Gruntfile is configured with the following:
- webpack: uses the grunt-webpack plugin to load all required modules and output to a single JS file
src/main.js. This is included in thesrc/index.htmlfile by default and will reload in the browser as and when it is recompiled. - webpack-dev-server: uses the webpack-dev-server to watch for file changes and also serve the webpack app in development.
- connect: uses the grunt-connect plugin to start a webserver at localhost.
- karma: uses the grunt-karma plugin to load the Karma configuration file
karma.conf.jslocated in the project root. This will run all tests using PhantomJS by default but supports many other browsers.
Included in the project is the normalize.css script. There is also a src/styles/main.css script that's required by the core src/components/App.js component using Webpack.
Please use JSXHint for linting JSX and the corresponding Sublime package if using SLT3 SublimeLinter-jsxhint. Note this is a global npm install and JSX files will need to be associated with the JSX file type withing SLT3.
Thanks to all who contributed to generator-angular as the majority of code here has been shamelessy sourced from that repos.
Thanks to Edd Hannay for his Webpack optimisations, my local merge and testing meant his additions lost his signature (my fault sorry) so big thanks Edd.
Contributions are welcomed. When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
node node_modules/.bin/mocha
