Skip to content

Latest commit

 

History

History
330 lines (96 loc) · 9.44 KB

README.md

File metadata and controls

330 lines (96 loc) · 9.44 KB
Raw

--- A nice structured yet simple starter kit for rapid application development using ReactJS, Webpack 4, and React Router v4.

❤️ Webpack 4
❤️ Code splitting
❤️ React Router
❤️ Redux

Why React redux starter Kit ?

  1. One command to get started - Type npm start to start development in your default browser.

  2. Rapid feedback - Each time you hit save, changes hot reload and linting and automated tests run.

  3. One command line to check - All feedback is displayed on a single command line.

  4. No more JavaScript fatigue - Starter Kit uses the most popular and powerful libraries for working with React.

  5. Working example app - The included an simplet counter example.

  6. Automated production build - Type npm run build to do all this:

React Redux starter kit prod build

Get Started

Initial Setup

  1. Install Node 8.0.0 or greater

Need to run multiple versions of Node? Use nvm.

  1. Install Git.

  2. Disable safe write in your editor to assure hot reloading works properly.

  3. Complete the steps below for your operating system:

macOS

  • Install watchman via brew install watchman or fswatch via brew install fswatch to avoid this issue which occurs if your macOS has no appropriate file watching service installed.

Linux

echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p.

Windows

  • Install Python 2.7. Some node modules may rely on node-gyp, which requires Python on Windows.

  • Install C++ Compiler. Browser-sync requires a C++ compiler on Windows.

Visual Studio Express comes bundled with a free C++ compiler.

If you already have Visual Studio installed:

Open Visual Studio and go to File -> New -> Project -> Visual C++ -> Install Visual C++ Tools for Windows Desktop.

The C++ compiler is used to compile browser-sync (and perhaps other Node modules).

Features

Build Process

State Management

Routing

HTTP

Styling

Develop & Deploy

Testing

  • Tested with Mocha and Chai
  • Coverage support
  • Sinon.JS for mocking, stubbing & spying

Having Issues? Try these things first

  1. Make sure you ran all steps in Get started including the initial machine setup.

  2. Run npm install - If you forget to do this, you'll see this: babel-node: command not found.

  3. Install the latest version of Node.

  4. Make sure files with names that begin with a dot (.editorconfig, .gitignore, .npmrc) are copied to the project directory root. This is easy to overlook if you copy this repository manually.

  5. Don't run the project from a symbolic link. It may cause issues with file watches.

  6. Delete any .eslintrc that you're storing in your user directory. Also, disable any ESLint plugin / custom rules that you've enabled within your editor. These will conflict with the ESLint rules defined in this project.

  7. Tip: Things to check if you get an npm run lint error or build error:

  • If ESW found an error or warning in your project (e.g. console statement or a missing semi-colon), the lint thread will exit with Exit status 1. To fix:

  1. Change the npm run lint script to "esw webpack.config.* src tools; exit 0"

  2. Change the npm run lint:watch script to "esw webpack.config.* src tools --watch; exit 0"

Note: Adding exit 0 will allow the npm scripts to ignore the status 1 and allow ESW to print all warnings and errors.

  • Ensure the eslint/esw globally installed version matches the version used in the project. This will ensure the esw keyword is resolved.
  1. Rebuild node-sass with npm rebuild node-sass if you are having and error like Node Sass does not yet support your current environment on macOS XXX after an initial npm start -s.

Technologies

React redux starter kit offers a rich development experience using the following technologies:

| Tech | Description |Learn More|

|----------|-------|---|

| React | Fast, composable client-side components. | Pluralsight Course |

| Redux | Enforces unidirectional data flows and immutable, hot reloadable store. Supports time-travel debugging. Lean alternative to Facebook's Flux.| Getting Started with Redux, Building React Applications with Idiomatic Redux, Pluralsight Course|

| React Router | A complete routing library for React | Pluralsight Course |

| Babel | Compiles ES6 to ES5. Enjoy the new version of JavaScript today. | ES6 REPL, ES6 vs ES5, ES6 Katas, Pluralsight course |

| Webpack | Bundles npm packages and our JS into a single file. Includes hot reloading via react-transform-hmr. | Quick Webpack How-to Pluralsight Course|

| Browsersync | Lightweight development HTTP server that supports synchronized testing and debugging on multiple devices. | Intro vid|

| Jest | Automated tests with built-in expect assertions and Enzyme for DOM testing without a browser using Node. | Pluralsight Course |

| TrackJS | JavaScript error tracking. | Free trial|

| ESLint| Lint JS. Reports syntax and style issues. Using eslint-plugin-react for additional React specific linting rules. | |

| SASS | Compiled CSS styles with variables, functions, and more. | Pluralsight Course|

| PostCSS | Transform styles with JS plugins. Used to autoprefix CSS |

| Editor Config | Enforce consistent editor settings (spaces vs tabs, etc). | IDE Plugins |

| npm Scripts| Glues all this together in a handy automated build. | Pluralsight course, Why not Gulp? |