generator-reapp v0.1.2

Yeoman React App Generator

This is a Yeoman generator which helps you dealing with a React/Redux application.

In order to work with this tool and the React environment you need NodeJS 4.2+ available on your machine. On a Mac I suggest to install NodeJS using Brew (click here for a tutorial).

If you are new to Yeoman you should install it:

npm install -g yo

And then you can install generator-reapp (this package):

npm install -g generator-reapp

Now Reapp is ready to use on your development machine.

Scaffold a React Client App

The first thing you may want to do with Reapp is to scaffold a brand new React Client Application:

yo reapp myNewApp

This command will guide you through the setup and eventually will create a new folder where to generate all the files that you need to work with React.

If you already know which name to give to your app you should run yo reapp myNewApp.

Once the generator finish its job you can run your app:

cd myNewApp
npm start

The newly generated application comes from es6-react-client project and you will find more informations about the file structure in it's readme.

The general architecture of this React/Redux client application is explained in details in the React Fast & Right book (early stage writing).

Scaffold a new Component

The most common piece of a React application is a dumb component, so a Component which doesn't know about the whole application and can be coded in complete isolation from it.

yo reapp:component SpeedIndicator

This command will guide you throth the setup and you may optionally build a Unit Test for your Component and a Styleguide page that load it.

The best way to work on a newly generated component is to run his Styleguide page:

npm start SpeedIndicator

A Styleguide is a dull application that renders one single component in many different ways and allows for isolated develpment and manual testing. Give it a try!