/generator-react-reflux-webpack

Yeoman generator for ReactJS and Webpack

Primary LanguageJavaScriptMIT LicenseMIT

generator-react-reflux-webpack Build Status Built with Grunt

Yeoman generator for ReactJS - lets you quickly set up a project including karma test runner and Webpack module system.

The project includes RefluxJS by default and Immutable is added if wanted.

This project was forked from the generator-react-webpack. And... it needs some cleaning up.

Usage

Install generator-react-reflux-webpack:

npm install -g generator-react-reflux-webpack

Make a new directory, and cd into it:

mkdir my-new-project && cd $_

Run yo react-reflux-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.

Generators

Available generators:

App

Sets up a new ReactJS app, generating all the boilerplate you need to get started. The app generator also facilitates the following:

  1. Configures a Gruntfile to run the app on a local server.
  2. Configures Webpack to modularise the app enabling loading of various file formats e.g. JSON, CSS, PNG, etc.
  3. Configures Karma to run all tests.
  4. Watches for changes and recompiles JS and refreshes the browser.

Example:

yo react-webpack

Component

Generates a JSX component in src/scripts/components and it's corresponding test in src/spec/components.

Example:

yo react-webpack:component foo

Produces src/scripts/components/Foo.js (javascript - JSX):

'use strict';

var React = require('react/addons');

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/scripts/components/Foo');
    component = Foo();
  });

  it('should create a new instance of Foo', function () {
    expect(component).toBeDefined();
  });
});

And src/styles/Foo.css:

.Foo{
  border: 1px dashed #f00;
}

Options

Options are available as additional installs to the initial application generation phase.

ReactRouter

A complete routing library for React. This option only adds the basic hooks to get started with react router.

Testing

Running grunt test will run the unit tests with karma. Tests are written using Jasmine by default.

Further Information

Project Structure

The react-webpack generator automates the setup of a ReactJS project using the specific structure detailed below:

project
  - src
    - scripts
      -components
        ComponentOne.js
        ComponentTwo.js
      -actions
        index.js
      -stores
        index.js
        RouterStore.js
      main.js
    - styles
      main.css
      normalize.css
    index.html
  - test
    - spec
      - components
        ComponentOne.js
        ComponentTwo.js
    - helpers
      - react
        addons.js
      phantomjs-shims.js
  Gruntfile.js
  karma.conf.js

I have tried to keep the project structure as simple as possible and understand it may not suit everyone.

Naming Components

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.

Modules

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.

Grunt

Out the box the Gruntfile is configured with the following:

  1. webpack: uses the grunt-webpack plugin to load all required modules and output to a single JS file src/scripts/main.js. This is included in the src/index.html file by default and will reload in the browser as and when it is recompiled.
  2. webpack-dev-server: uses the webpack-dev-server to watch for file changes and also serve the webpack app in development.
  3. connect: uses the grunt-connect plugin to start a webserver at localhost.
  4. karma: uses the grunt-karma plugin to load the Karma configuration file karma.conf.js located in the project root. This will run all tests using PhantomJS by default but supports many other browsers.

CSS

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/scripts/components/App.js component using Webpack.

JSHint

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.

Props

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.

Contribute

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.

Running Tests

node node_modules/.bin/mocha

License

BSD license

Bitdeli Badge