Simple Redux Boilerplate

A simple, yet comprehensive React + Redux application, complete with DevTools.

Maintainer: Edward D. Gaudio - edg.audio

Feel free to contribute! Just make a pr and issue with your suggestions/changes

---

Overview

Available Branches:

Checkout a branch to start with exactly what you need, explore others to learn how additional features might be implemented!

Branch	Description	Status
master	Basic React, Redux, with DevTools.	Complete, with SCSS now
react-router-redux	Adds 'react-router' and Redux bindings!	In Progress!

This is the perfect way to start any React + Redux application - especially if you're looking for a middle-ground. Minimize bulk and overhead - and get the exact amount of tools and configuration necessary to hit the ground running!

With educational comments and documentation sprinkled throughout this app, you'll learn and see how all the pieces come together - from Webpack and Babel all the way through React with Redux.

Designed to keep style/structure as un-opinionated as possible, to offer you - the user - as much creativity and flexibility when it comes to your needs. As this is still a work-in-progress, do reach out if you have suggestions, fixes, etc! If you want to help, a basic Roadmap can be found below!

This project features a super simple UI - just for you to see how everything is wired up, using the classic counter example and a simple api pull using thunks:

If you found this helpful, please star/fork/follow me on GitHub and follow me on Twitter!

Features

Basic:

• React + Redux
• Babel 6 w/ basic presets and transform
• Webpack w/ basic dev and prod configurations
• Express development server; easily roll out a production enabled server of your own
• Eslint w/ basic configs
• Redux DevTools + Logger middleware - easily removable/replaceable based on your needs

Optional:

• React Router + bindings (checkout react-router-redux branch for more info)

---

Requirements

• node 6.8.1 and higher!
  • you can use a version manager like n

---

FAQ

• Why another React and Redux boilerplate?

There are tons of great boilerplates out there, some of them with some pretty advanced functionality! But they aren't good for learning the holistic approach of getting a React/Redux app up and running. I wanted to create a boilerplate that would encourage and help the user learn how everything is set up, from Babel and Webpack through conditional requires and giving them the DevTools they need!

• Why not use WebpackDevServer?

The included devServer.js is a Node/Express server - mainly because most people will end up creating applications that rely on a Node server! Using the webpack-dev-middleware and webpack-hot-middleware allow us to get syntax errors displayed in an overlay, which using WebpackDevServer doesn't allow for.

Usage

Getting Started:

To begin, fork this repo and then clone those contents down!

Ideally, fork this boilerplate, then clone.

$ git clone https://github.com/YOUR_GITHUB_USERNAME_HERE/simple-redux-boilerplate.git

Install required dependencies. (Did you make sure you have the right version of Node?)

npm install

Run development server, complete with DevTools and related configuration.

npm run dev

You're now ready to get working! (enter command or visit via browser directly)

open http://localhost:3000/

---

Next Steps & Other Notes:

Now that your development server is up and running, you will see that you have your Redux DevTools available for you to use. The keyboard shortcuts available follow the generally accepted config - but you're free to make changes to them here: containers/DevTools.js.

To toggle the DevTool panel during development: CTRL + H

Change the DevTool panel's position during development: CTRL + Q

---

Roadmap

• Base boilerplate design off of "react-transform-boilerplate"
• Begin work on a complementary Yeoman generated package
• Implement Redux
• Implement Redux DevTools
• Optional Redux Logger Middleware is included (pop open console to see logging)
• Conditional require statements of configureStore.js and Root.js - based on whether user is in development or production environments
• Clean up Redux actions, reducers, constants
• Add basic styles and enable webpack compilation of CSS/SASS
• Provide additional documentation and example of pushing to production

---

Style Guide

Code style can be a tricky subject - I've instead decided to rely on the ever trustworthy configurations that AirBnb follows!

This project relies on eslint-config-airbnb. Learn more here: AirBnb Style Guide

---

Credits

Other Contributors:

This boilerplate was initially based on simple-redux-boilerplate. by @tsaiDavid

Which was in turn based initially on @gaeron's react-transform-boilerplate.

This project supports Babel 6, with reference implementations of:

babel-plugin-react-transform. It can be used as a boilerplate for quickly getting a new project up and running with a few useful transforms:

• react-transform-hmr - enables hot reloading react components
• react-transform-catch-errors - catches errors inside render()

For convenience they are packed in a single preset called react-transform-hmre but you can make your own.

Syntax errors are displayed in an overlay using @glenjamin’s webpack-hot-middleware, which replaces Webpack Dev Server. This project does not use React Hot Loader.