react_on_rails 5.2.0 → 6.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1fb981f3321f2cf6d28a3a3c1550bf60db230df
-  data.tar.gz: fdde71cf3cd95b818f030002e213dcc48885cb86
+  metadata.gz: eccbfc7edbe4d39c8b80673c50d25c2c3e21ab9c
+  data.tar.gz: 2eb9f721f5b67a58e7d3c392614042c6a4a3b8c4
 SHA512:
-  metadata.gz: 12dcf6e3bb24210b14cd40ca74643c548d88b592291465bdb427d1eb26b9028ff7eab7e0afa1c95f1f3becd2d175117f83a1d9a0f290337804cf74a7838cc7a0
-  data.tar.gz: 946fe32089268078bb1c7ce4bc1ed6e785572ee2d75f88239d2d586c70e21eab5b7afeb35608dc2a188cf14f06f7d85f4a6136677f9c62c43916e2402ffdd2b1
+  metadata.gz: 55115761bd37dc567a886ed5092b4d7101f166d5ec2741c816f26e59248a979fb378373a0189c6cb0fb31c1be98d553b188ea2145bb6b30afc0c844a2ba178da
+  data.tar.gz: b63c6519d7f9b75a8fa71ff7e73ff354ecc13afa6aa206952ff96719cd9736ea8e511137d48f96f98e558031ed89a0c0754fd5843a10459d08b889b85bd09a1d

data/.gitignore

@@ -28,3 +28,5 @@ npm-debug.*
 spec/dummy/client/npm-debug.log.*
 
 /gen-examples
+
+.DS_Store

data/.travis.yml

@@ -44,3 +44,4 @@ script:
 notifications:
   slack:
     secure: LfcUk4AJ4vAxWwRIyw4tFh8QNbYefMwfG/oLfsN3CdRMWMOtCOHR1GGsRhAOlfVVJ/FvHqVqWj5gK7z7CaO5Uvl7rD3/zJ8QzExKx/iH9yWj55iIPuKLzwFNnBwRpFW/cqyU2lFPPRxGD50BUn3c+qybkuSqtKZ6qtTowwqlxLa5iyM3N95aZp7MEIKCP7cPcnHfLbJyP8wBpotp/rtw62eXM2HIRJJwgjcp+n+My7VFR9DnBXNFf6R91aZHM4U4cHHDbu15HFtH8honVrzK1JQdyqMNHga+j04dFuaS7z9Q369/hsELMOBp/227+Pz7ZRfWZFK4UASguOvyeX7RmGTRpTuWLm1XJeUzfsPZVROecaSVQBve+U7F12yKqilt97QlvRXn2EGyBILqvxtFNNR4S9kgAf72/6EFgiM1TKq7i9zy6lVOnagU2+7amq7UeopX1uoFsUfNKMR7YbgV1WjF0IK95UP0b0/7ZOJlPYgi5zzkQi129qAFWSMmxGk+ZpsttHh/tjJtvAh0A3mHq/zb5w4ub/MbSyZqeDUNgGj72QArOWUFSAStQT1ybsVLeDoKPgOvVq7OV1D64rpcHjBXcqOCit8tDZ+TqkFhcYJo2cITSaqE4zJXn+4F5s7So5O8CyfKYQq+kFJCooYGmfgTUckJpGl7eIvKmL4TN9Q=
+

data/CHANGELOG.md

@@ -2,11 +2,42 @@
 All notable changes to this project will be documented in this file. Items under `Unreleased` is upcoming features that will be out in next version.
 
 Contributors: please follow the recommendations outlined at [keepachangelog.com](http://keepachangelog.com/). Please use the existing headings and styling as a guide, and add a link for the version diff at the bottom of the file. Also, please update the `Unreleased` link to compare to the latest release version.
+
 ## [Unreleased]
+##### Breaking Changes
+- Added automatic compilation of assets at precompile is now done by ReactOnRails. Thus, you don't need to provide your own assets.rake file that does the precompilation. 
+  [#398](https://github.com/shakacode/react_on_rails/pull/398).
+- Migration: you can either
+  
+  1. Specify a `config/react_on_rails` setting for `npm_build_production_command` to be nil to turn this feature off.
+  2. Specify the script command you want to run to build your production assets, and remove your assets.rake file.
+
+Here is the addition to the generated config file:
+```ruby
+  # This configures the script to run to build the production assets by webpack. Set this to nil
+  # if you don't want react_on_rails building this file for you.
+  config.npm_build_production_command = "npm run build:production"
+```
+
+##### Fixed
+- Fixed errors when server rendered props contain \u2028 or \u2029 characters [#375](https://github.com/shakacode/react_on_rails/pull/375) by [mariusandra]
+
+##### Added
+- Non-digested version of assets in public folder [#413](https://github.com/shakacode/react_on_rails/pull/413) by [alleycat-at-git]
+
+##### Changed
+- Only one webpack config is generated for server and client config. Package.json files were changed to reflect this [#398](https://github.com/shakacode/react_on_rails/pull/398).
+- Added npm_build_test_command to allow developers to change what npm command is automatically run from rspec [#398](https://github.com/shakacode/react_on_rails/pull/398).
+- Replace URI with Addressable gem. See [#405](https://github.com/shakacode/react_on_rails/pull/405) by [lucke84]
+
+##### Removed
+- Server rendering is no longer an option in the generator and is always accessible [#398](https://github.com/shakacode/react_on_rails/pull/398).
+- removed lodash, jquery, and loggerMiddleware from the generated code [#398](https://github.com/shakacode/react_on_rails/pull/398).
 
 ## [5.2.0] - 2016-04-08
 ##### Added
 - Support for React 15.0 to react_on_rails. See [#379](https://github.com/shakacode/react_on_rails/pull/379) by [brucek](https://github.com/brucek).
+- Support for Node.js server side rendering. See [#380](https://github.com/shakacode/react_on_rails/pull/380) by [alleycat](https://github.com/alleycat-at-git) and [doc](https://github.com/shakacode/react_on_rails/blob/master/docs/additional-reading/node-server-rendering.md)
 
 ##### Removed
 - Generator removals to simplify installer. See [#363](https://github.com/shakacode/react_on_rails/pull/363) by [jbhatab](https://github.com/jbhatab).

data/PROJECTS.md

@@ -2,13 +2,22 @@
 
 *Please add your project to this list.*
 
-## Commercial Products
+## Commercial Products Live
 * **[Blink Inc](https://www.blinkinc.com)**: Website and more built by [ShakaCode](http://www.shakacode.com).
+* **[Madrone Analytics](http://madroneco.com/)**: The original client of [ShakaCode](http://www.shakacode.com) that led to the development of React on Rails, as described in [Fast Rich Client Rails Development With Webpack and the ES6 Transpiler](http://www.railsonmaui.com/blog/2014/10/03/integrating-webpack-and-the-es6-transpiler-into-an-existing-rails-project/).
+* **[Deliveroo](https://deliveroo.co.uk/)**: The leading food delivery site in Europe has gone live with React on Rails, with multi-lingual JavaScript support!* 
+![2016-05-03_19-18-34](https://cloud.githubusercontent.com/assets/1118459/15027253/91fd151a-11de-11e6-93e3-720518995fe0.png)
+
+ 
+
+
+
+## Commercial Products in Development
 * **[GuavaPass](https://guavapass.com/)**: Coaching client of [ShakaCode](http://www.shakacode.com) and React on Rails fan!
 * **Friends and Guests**, the signature product of [ShakaCode](http://www.shakacode.com), which is a "Social Network Connecting Hosts and Guests". *Coming soon!*
-* **[Madrone Analytics](http://madroneco.com/)**: The original client of [ShakaCode](http://www.shakacode.com) that led to the development of React on Rails, as described in [Fast Rich Client Rails Development With Webpack and the ES6 Transpiler](http://www.railsonmaui.com/blog/2014/10/03/integrating-webpack-and-the-es6-transpiler-into-an-existing-rails-project/).
 * **[Pivotal Tracker](http://www.pivotaltracker.com/)**: The first (and most-loved) agile project management tool built on Rails.  React on Rails has greatly simplified integration and workflow for our React components in Rails!
 * **[Confident Financial Solutions](https://www.mycfsapp.com/)**: Auto Repair Financing to help people get back on the road and back to life.
+* **[Apprentus](https://www.apprentus.com/)**: A marketplace to find the best private teachers. Using react-on-rails from the homepage to infinity!
 
 --------
 

data/README.md

@@ -1,15 +1,18 @@
 [![Build Status](https://travis-ci.org/shakacode/react_on_rails.svg?branch=master)](https://travis-ci.org/shakacode/react_on_rails)  [![Dependency Status](https://gemnasium.com/shakacode/react_on_rails.svg)](https://gemnasium.com/shakacode/react_on_rails) [![Gem Version](https://badge.fury.io/rb/react_on_rails.svg)](https://badge.fury.io/rb/react_on_rails) [![npm version](https://badge.fury.io/js/react-on-rails.svg)](https://badge.fury.io/js/react-on-rails) [![Code Climate](https://codeclimate.com/github/shakacode/react_on_rails/badges/gpa.svg)](https://codeclimate.com/github/shakacode/react_on_rails) [![Coverage Status](https://coveralls.io/repos/shakacode/react_on_rails/badge.svg?branch=master&service=github)](https://coveralls.io/github/shakacode/react_on_rails?branch=master)
- 
+
 # NEWS
-* 2016-04-08: 5.2.0 Released! Support for React 15.0 and upates to the Generator. See the [CHANGELOG.md](./CHANGELOG.md) for details.
+* 2016-04-08: 5.2.0 Released! Support for React 15.0 and updates to the Generator. See the [CHANGELOG.md](./CHANGELOG.md) for details.
 * [New slides on React on Rails](http://www.slideshare.net/justingordon/react-on-rails-v4032).
-* 2016-02-28: We added a [Projects page](./PROJECTS.md) and a [Kudos page](./KUDOS.md). Please edit the page your project or [email us](mailto:contact@shakacode.com) and we'll add you. We also love stars as it helps us attract new users and contributors.
-* *See [NEWS.md](NEWS.md) for the full news history.*
+* 2016-02-28: We added a [Projects page](./PROJECTS.md) and a [Kudos page](./KUDOS.md). Please edit the page and add your project or [email us](mailto:contact@shakacode.com) and we'll add you. We also love stars as it helps us attract new users and contributors.
+* *See [NEWS.md](NEWS.md) for more notes over time.*
 
 # NOTES
 * React on Rails does not yet have *generator* support for building new apps that use CSS modules and hot reloading via the Rails server as is demonstrated in the [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/). *We do support this, but we don't generate the code.* If you did generate a fresh app from react_on_rails and want to move to CSS Modules, then see [PR 175: Babel 6 / CSS Modules / Rails hot reloading](https://github.com/shakacode/react-webpack-rails-tutorial/pull/175). Note, while there are probably fixes after this PR was accepted, this has the majority of the changes. See [the tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/#news) for more information. For more information on how to setup hot reloading in a Rails app, see [Hot Reloading of Assets For Rails Development](docs/additional-reading/hot-reloading-rails-development.md).
 * [ShakaCode](http://www.shakacode.com) is doing Skype plus Slack/Github based coaching for "React on Rails". [Click here](http://www.shakacode.com/work/index.html) for more information.
-* Be sure to read our article [The React on Rails Doctrine](https://medium.com/@railsonmaui/the-react-on-rails-doctrine-3c59a778c724).
+* Be sure to read our article [The React on Rails Doctrine](https://medium.com/@railsonmaui/the-react-on-rails-doctrine-3c59a778c724) and see [slides on React on Rails](http://www.slideshare.net/justingordon/react-on-rails-v4032).
+* [React Webpack Rails Tutorial Code](https://github.com/shakacode/react-webpack-rails-tutorial) along with the live example at [www.reactrails.com](http://www.reactrails.com).
+* [Projects](PROJECTS.md) using and [KUDOS](./KUDOS.md) for React on Rails. Please submit yours!
+* On Twitter, follow [@railsonmaui](https://twitter.com/railsonmaui) and [@shakacode](https://twitter.com/shakacode) for updates on releases.
 
 # React on Rails
 
@@ -17,13 +20,6 @@
 
 React on Rails integrates Facebook's [React](https://github.com/facebook/react) front-end framework with Rails. React v0.14.x is supported, with server rendering. [Redux](https://github.com/reactjs/redux) and [React-Router](https://github.com/reactjs/react-redux) are supported as well, also with server rendering. See the Rails on Maui [blog post](http://www.railsonmaui.com/blog/2014/10/03/integrating-webpack-and-the-es6-transpiler-into-an-existing-rails-project/) that started it all!
 
-Be sure to see:
-* [React on Rails, Slides](http://www.slideshare.net/justingordon/react-on-rails-v4032)
-* [The React on Rails Doctrine](https://medium.com/@railsonmaui/the-react-on-rails-doctrine-3c59a778c724)
-* [React Webpack Rails Tutorial Code](https://github.com/shakacode/react-webpack-rails-tutorial) along with the live example at [www.reactrails.com](http://www.reactrails.com).
-* [Projects](PROJECTS.md) using and [KUDOS](./KUDOS.md) for React on Rails. Please submit yours!
-* On Twitter, follow [@railsonmaui](https://twitter.com/railsonmaui) and [@shakacode](https://twitter.com/shakacode) for updates on releases.
-
 ## Including your React Component in your Rails Views
 Please see [Getting Started](#getting-started) for how to set up your Rails project for React on Rails to understand how `react_on_rails` can see your ReactComponents.
 
@@ -75,10 +71,6 @@ Please see [Getting Started](#getting-started) for how to set up your Rails proj
     - [ReactOnRails View Helpers API](#reactonrails-view-helpers-api)
     - [ReactOnRails JavaScript API](#reactonrails-javascript-api)
     - [React-Router](#react-router)
-+ [Generator](#generator)
-    - [Understanding the Organization of the Generated Client Code](#understanding-the-organization-of-the-generated-client-code)
-    - [Redux](#redux)
-      - [Multiple React Components on a Page with One Store](#multiple-react-components-on-a-page-with-one-store)
 + [Adding Additional Routes for the Dev Server](#adding-additional-routes-for-the-dev-server)
 + [Migrate From react-rails](#migrate-from-react-rails)
 + [Additional Reading](#additional-reading)
@@ -144,7 +136,7 @@ We're definitely not doing that. With react_on_rails, webpack is mainly generati
 
 ### Installation Summary
 
-See the [Installation Overview](docs/additional-reading/installation-overview.md) for a concise set summary of what's in a React on Rails installation.
+See the [Installation Overview](docs/basics/installation-overview.md) for a concise set summary of what's in a React on Rails installation.
 
 ### Initializer Configuration
 
@@ -169,8 +161,6 @@ In most cases, you should use the `prerender: false` (default behavior) with the
 
 Now the server will interpret your JavaScript using [ExecJS](https://github.com/rails/execjs) and pass the resulting HTML to the client. We recommend using [therubyracer](https://github.com/cowboyd/therubyracer) as ExecJS's runtime. The generator will automatically add it to your Gemfile for you.
 
-Note that **server-rendering requires globally exposing your components by setting them to `global`, not `window`** (as is the case with client-rendering). If using the generator, you can pass the `--server-rendering` option to configure your application for server-side rendering.
-
 In the following screenshot you can see the 3 parts of React on Rails rendering:
 
 1. A hidden HTML div that contains the properties of the React component, such as the registered name and any props. A JavaScript function runs after the page loads to convert take this data and build initialize React components.
@@ -207,7 +197,9 @@ and for a store:
 reduxStore = MyReduxStore(props, railsContext);
 ```
 
-Note, you never make these calls. This is what React on Rails does when either server or client rendering.
+Note, you never make these calls. This is what React on Rails does when either server or client rendering. You'll be definining functions that take take these params and return a React component or a Redux Store. 
+
+(Note, see below [section](#multiple-react-components-on-a-page-with-one-store) on how to setup redux stores that allow multiple components to talk to the same store.)
 
 The `railsContext` has: (see implementation in file react_on_rails_helper.rb for method rails_context for the definitive list).
 
@@ -218,7 +210,7 @@ The `railsContext` has: (see implementation in file react_on_rails_helper.rb for
     location: "#{uri.path}#{uri.query.present? ? "?#{uri.query}": ""}",
     scheme: uri.scheme, # http
     host: uri.host, # foo.com
-    port: uri.port, 
+    port: uri.port,
     pathname: uri.path, # /posts
     search: uri.query, # id=30&limit=5
 
@@ -226,7 +218,7 @@ The `railsContext` has: (see implementation in file react_on_rails_helper.rb for
     i18nLocale: I18n.locale,
     i18nDefaultLocale: I18n.default_locale,
     httpAcceptLanguage: request.env["HTTP_ACCEPT_LANGUAGE"],
-    
+
     # Other
     serverSide: boolean # Are we being called on the server or client? NOTE, if you conditionally
      # render something different on the server than the client, then React will only show the
@@ -241,6 +233,9 @@ Suppose you want to display a nav bar with the current navigation link highlight
 ##### Needing the I18n.locale
 Suppose you want to server render your react components with localization applied given the current Rails locale. The `railsContext` contains the I18n.locale.
 
+##### Configuring different code for server side rendering
+Suppose you want to turn off animation when doing server side rendering. The `serverSide` value is just what you need.
+
 #### Customization of the rails_context
 You can customize the values passed in the `railsContext` in your `config/initializers/react_on_rails.rb`. Here's how.
 
@@ -273,28 +268,20 @@ In this case, a prop and value for `somethingUseful` will go into the railsConte
 ### Globally Exposing Your React Components
 Place your JavaScript code inside of the provided `client/app` folder. Use modules just as you would when using webpack alone. The difference here is that instead of mounting React components directly to an element using `React.render`, you **expose your components globally and then mount them with helpers inside of your Rails views**.
 
-+ *Normal Mode (JavaScript is Rendered on client):*
-
-  If you are not server rendering, `clientRegistration.jsx` will have
-
-  ```javascript
-  import HelloWorld from '../components/HelloWorld';
-  import ReactOnRails from 'react-on-rails';
-  ReactOnRails.register({ HelloWorld });
-  ```
-+ *Server-Side Rendering:*
-
-  If you are server rendering, `serverRegistration.jsx` will have this. Note, you might be initializing HelloWorld with version specialized for server rendering.
+This is an example of how to expose a component to the `react_component` view helper.
 
   ```javascript
+  // client/app/bundles/HelloWorld/startup/HelloWorldApp.jsx
   import HelloWorld from '../components/HelloWorld';
   import ReactOnRails from 'react-on-rails';
   ReactOnRails.register({ HelloWorld });
   ```
 
-  In general, you may want different initialization for your server rendered components.
+#### Different Server-Side Rendering Code (and a Server Specific Bundle)
 
-See below section on how to setup redux stores that allow multiple components to talk to the same store.
+You may want different initialization for your server rendered components. For example, if you have animation that runs when a component is displayed, you might need to turn that off when server rendering. However, the `railsContext` will tell you if your JavaScript code is running client side or server side. So code that required a different server bundle previously may no longer require this!
+ 
+If you do want different code to run, you'd setup a separate webpack compilation file and you'd specify a different, server side entry file. ex. 'serverHelloWorldApp.jsx'. Note, you might be initializing HelloWorld with version specialized for server rendering.
 
 ## ReactOnRails View Helpers API
 Once the bundled files have been generated in your `app/assets/webpack` folder and you have exposed your components globally, you will want to run your code in your Rails views using the included helper method.
@@ -302,14 +289,16 @@ Once the bundled files have been generated in your `app/assets/webpack` folder a
 This is how you actually render the React components you exposed to `window` inside of `clientRegistration` (and `global` inside of `serverRegistration` if you are server rendering).
 
 ### react_component
-`react_component(component_name,
+```ruby
+react_component(component_name,
                 props: {},
                 prerender: nil,
                 trace: nil,
                 replay_console: nil,
                 raise_on_prerender_error: nil,
                 id: nil,
-                html_options: {})`
+                html_options: {})
+```
 
 + **component_name:** Can be a React component, created using a ES6 class, or `React.createClass`, or a generator function that returns a React component.
 + **options:**
@@ -356,136 +345,6 @@ Why would you create a function that returns a React component? For example, you
 
 This is a helper method that takes any JavaScript expression and returns the output from evaluating it. If you have more than one line that needs to be executed, wrap it in an IIFE. JS exceptions will be caught and console messages handled properly.
 
-## ReactOnRails JavaScript API
-The best source of docs is the main [ReactOnRails.js](node_package/src/ReactOnRails.js) file. Here's a quick summary. No guarantees that this won't be outdated!
-
-```js
-  /**
-   * Main entry point to using the react-on-rails npm package. This is how Rails will be able to
-   * find you components for rendering.
-   * @param components (key is component name, value is component)
-   */
-  register(components)
-
-  /**
-   * Allows registration of store generators to be used by multiple react components on one Rails
-   * view. store generators are functions that take one arg, props, and return a store. Note that
-   * the setStore API is different in tha it's the actual store hydrated with props.
-   * @param stores (key is store name, value is the store generator)
-   */
-  registerStore(stores)
-
-  /**
-   * Allows retrieval of the store by name. This store will be hydrated by any Rails form props.
-   * Pass optional param throwIfMissing = false if you want to use this call to get back null if the
-   * store with name is not registered.
-   * @param name
-   * @param throwIfMissing Defaults to true. Set to false to have this call return undefined if
-   *        there is no store with the given name.
-   * @returns Redux Store, possibly hydrated
-   */
-  getStore(name, throwIfMissing = true )
-
-  /**
-   * Set options for ReactOnRails, typically before you call ReactOnRails.register
-   * Available Options:
-   * `traceTurbolinks: true|false Gives you debugging messages on Turbolinks events
-   */
-  setOptions(options)
-```
-
-## Hot Reloading View Helpers
-The `env_javascript_include_tag` and `env_stylesheet_link_tag` support the usage of a webpack dev server for providing the JS and CSS assets during development mode. See the [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/) for a working example.
-
-The key options are `static` and `hot` which specify what you want for static vs. hot. Both of these params are optional, and support either a single value, or an array.
-
-static vs. hot is picked based on whether `ENV["REACT_ON_RAILS_ENV"] == "HOT"`
-
-```erb
- <%= env_stylesheet_link_tag(static: 'application_static',
-                             hot: 'application_non_webpack',
-                             media: 'all',
-                             'data-turbolinks-track' => true)  %>
-
- <!-- These do not use turbolinks, so no data-turbolinks-track -->
- <!-- This is to load the hot assets. -->
- <%= env_javascript_include_tag(hot: ['http://localhost:3500/vendor-bundle.js',
-                                      'http://localhost:3500/app-bundle.js']) %>
-
- <!-- These do use turbolinks -->
- <%= env_javascript_include_tag(static: 'application_static',
-                                hot: 'application_non_webpack',
-                                'data-turbolinks-track' => true) %>
-```
-
-See application.html.erb for usage example and [application.html.erb](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/app%2Fviews%2Flayouts%2Fapplication.html.erb)
-
-**env_javascript_include_tag(args = {})**
-
-Helper to set CSS assets depending on if we want static or "hot", which means from the Webpack dev server.
-
-In this example, application_non_webpack is simply a CSS asset pipeline file which includes styles not placed in the webpack build.
-
-We don't need styles from the webpack build, as those will come via the JavaScript include tags.
-
-The key options are `static` and `hot` which specify what you want for static vs. hot. Both of
-these params are optional, and support either a single value, or an array.
-
-```erb
- <%= env_stylesheet_link_tag(static: 'application_static',
-                             hot: 'application_non_webpack',
-                             media: 'all',
-                             'data-turbolinks-track' => true)  %>
-```
-
-**env_stylesheet_link_tag(args = {})**
-
-## Generator
-The `react_on_rails:install` generator combined with the example pull requests of generator runs will get you up and running efficiently. There's a fair bit of setup with integrating Webpack with Rails. Defaults for options are such that the default is for the flag to be off. For example, the default for `-R` is that `redux` is off, and the default of `-b` is that `skip-bootstrap` is off.
-
-Run `rails generate react_on_rails:install --help` for descriptions of all available options:
-
-```
-Usage:
-  rails generate react_on_rails:install [options]
-
-Options:
-  -R, [--redux], [--no-redux]                          # Install Redux gems and Redux version of Hello World Example
-  -S, [--server-rendering], [--no-server-rendering]    # Add necessary files and configurations for server-side rendering
-
-Runtime options:
-  -f, [--force]                    # Overwrite files that already exist
-  -p, [--pretend], [--no-pretend]  # Run but do not make any changes
-  -q, [--quiet], [--no-quiet]      # Suppress status output
-  -s, [--skip], [--no-skip]        # Skip files that already exist
-
-Description:
-    Create react on rails files for install generator.
-```
-
-For a clear example of what each generator option will do, see our generator results repo: [Generator Results](https://github.com/shakacode/react_on_rails-generator-results/blob/master/README.md). Each pull request shows a git "diff" that highlights the changes that the generator has made. Another good option is to create a simple test app per the [Tutorial](docs/tutorial.md).
-
-### Understanding the Organization of the Generated Client Code
-The generated client code follows our organization scheme. Each unique set of functionality, is given its own folder inside of `client/app/bundles`. This encourages for modularity of *domains*.
-
-Inside of the generated "HelloWorld" domain you will find the following folders:
-
-+  `startup`: two types of files, one that return a container component and implement any code that differs between client and server code (if using server-rendering), and a `clientRegistration` file that exposes the aforementioned files (as well as a `serverRegistration` file if using server rendering). These registration files are what webpack is using as an entry point.
-+ `containers`: "smart components" (components that have functionality and logic that is passed to child "dumb components").
-+ `components`: includes "dumb components", or components that simply render their properties and call functions given to them as properties by a parent component. Ultimately, at least one of these dumb components will have a parent container component.
-
-You may also notice the `app/lib` folder. This is for any code that is common between bundles and therefore needs to be shared (for example, middleware).
-
-### Redux
-If you have used the `--redux` generator option, you will notice the familiar additional redux folders in addition to the aforementioned folders. The Hello World example has also been modified to use Redux.
-
-Note the organizational paradigm of "bundles". These are like application domains and are used for grouping your code into webpack bundles, in case you decide to create different bundles for deployment. This is also useful for separating out logical parts of your application. The concept is that each bundle will have it's own Redux store. If you have code that you want to reuse across bundles, including components and reducers, place them under `/client/app/lib`.
-
-### Using Images and Fonts
-The generator has amended the folders created in `client/assets/` to Rails's asset path. We recommend that if you have any existing assets that you want to use with your client code, you should move them to these folders and use webpack as normal. This allows webpack's development server to have access to your assets, as it will not be able to see any assets in the default Rails directories which are above the `/client` directory.
-
-Alternatively, if you have many existing assets and don't wish to move them, you could consider creating symlinks from client/assets that point to your Rails assets folders inside of `app/assets/`. The assets there will then be visible to both Rails and webpack.
-
 ## Multiple React Components on a Page with One Store
 You may wish to have 2 React components share the same the Redux store. For example, if your navbar is a React component, you may want it to use the same store as your component in the main area of the page. You may even want multiple React components in the main area, which allows for greater modularity. In addition, you may want this to work with Turbolinks to minimize reloading the JavaScript. A good example of this would be something like an a notifications counter in a header. As each notifications is read in the body of the page, you would like to update the header. If both the header and body share the same Redux store, then this is trivial. Otherwise, we have to rely on other solutions, such as the header polling the server to see how many unread notifications exist.
 
@@ -493,7 +352,7 @@ Suppose the Redux store is called `appStore`, and you have 3 React components th
 
 You will need to make a function that can create the store you will be using for all components and register it via the `registerStore` method. Note, this is a **storeCreator**, meaning that it is a function that takes (props, location) and returns a store:
 
-```
+```js
 function appStore(props, railsContext) {
   // Create a hydrated redux store, using props and the railsContext (object with
   // Rails contextual information).
@@ -548,43 +407,13 @@ Components are created as [stateless function(al) components](https://facebook.g
 1. [React on Rails docs for react-router](docs/additional-reading/react-router.md)
 1. Examples in [spec/dummy/app/views/react_router](spec/dummy/app/views/react_router) and follow to the JavaScript code in the [spec/dummy/client/app/startup/ServerRouterApp.jsx](spec/dummy/client/app/startup/ServerRouterApp.jsx).
 
-## Developing with the Webpack Dev Server
-One of the benefits of using webpack is access to [webpack's dev server](https://webpack.github.io/docs/webpack-dev-server.html) and its [hot module replacement](https://webpack.github.io/docs/hot-module-replacement-with-webpack.html) functionality.
-
-The webpack dev server with HMR will apply changes from the code (or styles!) to the browser as soon as you save whatever file you're working on. You won't need to reload the page, and your data will still be there. Start foreman as normal (it boots up the Rails server *and* the webpack HMR dev server at the same time).
-
-  ```bash
-  foreman start -f Procfile.dev
-  ```
-
-Open your browser to [localhost:3000](http://localhost:3000). Whenever you make changes to your JavaScript code in the `client` folder, they will automatically show up in the browser. Hot module replacement is already enabled by default.
-
-Note that **React-related error messages are typically significantly more helpful when encountered in the dev server** than the Rails server as they do not include noise added by the React on Rails gem.
-
-### Adding Additional Routes for the Dev Server
-As you add more routes to your front-end application, you will need to make the corresponding API for the dev server in `client/server.js`. See our example `server.js` from our [tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client%2Fserver-express.js).
-
-## Migrate From react-rails
-If you are using [react-rails](https://github.com/reactjs/react-rails) in your project, it is pretty simple to migrate to [react_on_rails](https://github.com/shakacode/react_on_rails).
-
-- Remove the 'react-rails' gem from your Gemfile.
-
-- Remove the generated lines for react-rails in your application.js file.
-
-```
-//= require react
-//= require react_ujs
-//= require components
-```
-
-- Follow our getting started guide: https://github.com/shakacode/react_on_rails#getting-started.
-
-Note: If you have components from react-rails you want to use, then you will need to port them into react_on_rails which uses webpack instead of the asset pipeline.
-
 ## Additional Reading
++ [JavaScript API](docs/api/javascript-api.md)
++ [Ruby API](docs/api/ruby-api.md)
++ [Setting up Hot Reloading during Rails Development, API docs](docs/api/ruby-api-hot-reload-view-helpers.md)
 + [React on Rails, Slides](http://www.slideshare.net/justingordon/react-on-rails-v4032)
 + [The React on Rails Doctrine](https://medium.com/@railsonmaui/the-react-on-rails-doctrine-3c59a778c724)
-+ [Installation Overview](docs/additional-reading/installation-overview.md)
++ [Installation Overview](docs/basics/installation-overview.md)
 + [Babel](docs/additional-reading/babel.md)
 + [Heroku Deployment](docs/additional-reading/heroku-deployment.md)
 + [Manual Installation](docs/additional-reading/manual-installation.md)
@@ -601,6 +430,7 @@ Note: If you have components from react-rails you want to use, then you will nee
 + [Webpack Cookbook](https://christianalfoni.github.io/react-webpack-cookbook/index.html)
 + [Changelog](CHANGELOG.md)
 + [Projects](PROJECTS.md)
++ [Developing with the Webpack Dev Server](docs/additional-reading/webpack-dev-server)
 
 ## Demos
 + [www.reactrails.com](http://www.reactrails.com) with the source at [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/).