README.md

react-boilerplate

DEPRECATION NOTICE

We have now migrated to a new boilerplate structure based on Create React App.

See generator-react-zeal for our new approach.

This respository will no longer be maintained going forward.

Thanks for your interest!

Zeal's boilerplate setup for React/Redux projects.

This boilerplate contains our standard React/Redux setup for larger single-page front-end applications.

We expect that the front-end application will be embedded into a project along with the back-end application, likely in Rails. The boilerplate is structured based on that assumption.

The boilerplate includes all of the tools that we're currently using in our React projects; you may not need all of it, so feel free to remove the parts that you don't need.

We assume some familiarity with the React/Redux ecosystem, including Babel and Webpack.

Getting Started

After creating the repository for your project, copy the files from this repo into your working directory. Be careful not to overwrite your README.md or .gitignore. You may want to merge the boilerplate's .gitignore with your own. Make sure you copy .eslintrc; that one's easy to miss when copying from the command-line, since it's a hidden file.

We've included an extremely simple starter application in the boilerplate. To try it out, run npm start. It will start the Webpack development server and open the application in your browser. You should see a heading that says Zeal React Boilerplate Test. If you look in the browser's console, you should see a message indicating that Hot Module Replacement is enabled.

The boilerplate is structured in modules, as described in Rules For Structuring (Redux) Applications. The sample module can be duplicated and modified for other features as needed.

Cleaning Up the Starter App

Once you've got your front-end application embedded into your real back-end server, you'll want to clean out the starter app. To do that:

• Delete index.html
• Delete webpack/starterApp.js
• Delete the start script line from package.json
• Change the contents of client/modules/app/components/App/index.js and the client/modules/sample module as appropriate for your application.

Notes of Interest

• We include flux-standard-action to indicate that our intention is to use that format for our actions. We don't currently import it anywhere, but if you're so inclined, you can use its isFSA() function to check your actions in tests or as a guard in the reducer returned from createReducer().

• We use husky to provide a git pre-push hook that runs tests and linters before allowing a git push. If you'd rather not have this, you can opt out of it permanently on your machine by creating a file named .opt-out with the line prepush in it. See the opt-cli package for more information. If you want to temporarily skip the pre-push hook (for example, to push up a WIP commit), you can use git push --no-verify to skip the hook for that single push.

ESLINT Configuration

Included in package.json are eslint and supporting modules. Included is also Zeal's eslint configuration as a dependency; eslint-config-zeal. The various build and dev scripts will use these configurations including of course the lint script. It is also recommended that if you are using an editor or IDE that supports lint plugins that you install those plugins for the benefit of realtime linting. For the Atom editor please see the linter and linter-eslint plugins.

Recipes

These are recipes for common things you might want to do, but that we don't really want in our standard boilerplate.

Using jQuery

With React, jQuery is almost never necessary, so think twice before deciding to include it.

However, sometimes we want to wrap a third-party component that uses jQuery. In that case, we don't have much choice, so here's how to include jQuery and make it globally available.

• In webpack/base.js, change:

new webpack.ProvidePlugin({
  fetch: 'imports?this=>global!exports?global.fetch!whatwg-fetch'
})

to:

new webpack.ProvidePlugin({
  fetch: 'imports?this=>global!exports?global.fetch!whatwg-fetch',
  jQuery: 'jquery',
  $: 'jquery'
})

This assumes that you've added jQuery to your package.json either directly or via another module.

• In .eslintrc.json, add:

"env": {
  "jquery": true
}

License

Authored by the Engineering Team of Coding ZEAL

Copyright (c) 2016 Zeal, LLC. Licensed under the MIT license.