Yet another react starterkit. Including react-router, reflux, jest, webpack, gulp and stylus.
JavaScript CSS HTML
Latest commit 8651242 Aug 1, 2016 @moklick moklick committed on GitHub Merge pull request #7 from e-wings/master
Minor update

README.md

React Starterkit

This react starterkit provides a prepared development environment based on gulp, stylus and webpack. The internal data flow is handled with Reflux and the routing is managed with the React-Router.

Demo

This starterkit does not include some fancy UI stuff but is a lightweight starting point for your next react app.

Get the kit

$ git clone https://github.com/wbkd/react-starterkit.git && cd react-starterkit

Installation

Install all dependencies.

$ npm install

Development

Builds the application and starts a webserver with livereload. By default the webserver starts at port 1337. You can define a port with $ gulp --port 3333.

$ npm start

Build

Builds a minified version of the application in the dist folder.

$ gulp build --type production

Testing

We use jest to test our application.
You can run the tests that are defined under app/scripts/__tests__ with

$ npm test

Javascript

Javascript entry file: app/scripts/main.js

Reflux

We are using Reflux, which is an implemantion of the Flux Architecture. If you want to read more about Reflux, check out the readme of the reflux git repo.

React-Router

The routing is done with the react-router. It's especially great for SPA's. We would recommend to read the guide to get an overview of the router features.

ES6 with babel

We are working with the webpack babel loader in order to load our .js/.jsx files. Babel allows you to use ES6 features like class, arrow functions and much more.

CSS

CSS entry file: app/stylus/main.styl

Stylus

As you can see we are using stylus to preprocess our .styl files. If you didn't work with a css preprocessor before the stylus page is a good starting point to get to know what stylus can do for you.

If you want to use third-party CSS you just include it via @import 'path/to/your/third-party-styles.css' at the top of the main.styl file.

Webpack Hints

You can find the webpack configuration in the webpack.config.js file. We use the babel-loader in order to load .jsx and .js files via webpack. If it's possible install all your dependencies with NPM. Packages installed with NPM can be used like this:


var moduleXYZ = require('moduleXYZ');

You can find all loaders in this list.

Requirements

  • node
  • npm
  • gulp