react_on_rails 12.0.1 → 13.0.0

data/docs/guides/getting-started.md

@@ -0,0 +1,183 @@
+# Getting Started
+
+Note, the best way to understand how to use ReactOnRails is to study a few simple examples. You can do a quick demo setup, either on your existing app or on a new Rails app.
+
+1. Do the quick [tutorial](https://www.shakacode.com/react-on-rails/docs/guides/tutorial/).
+2. Add React on Rails to an existing Rails app per [the instructions](https://www.shakacode.com/react-on-rails/docs/guides/installation-into-an-existing-rails-app/).
+3. Look at [spec/dummy](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy), a simple, no DB example.
+3. Look at [github.com/shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial); it's a full-featured example live at [www.reactrails.com](http://reactrails.com).
+
+## Basic Installation
+
+*See also [the instructions for installing into an existing Rails app](https://www.shakacode.com/react-on-rails/docs/guides/installation-into-an-existing-rails-app/).*
+
+1. Add the `react_on_rails` gem to Gemfile:
+
+   ```bash
+   bundle add react_on_rails --strict
+   ```
+
+2. Commit this to git (or else you cannot run the generator unless you pass the option `--ignore-warnings`).
+
+3. Run the generator:
+
+   ```bash
+   rails generate react_on_rails:install
+   ```
+
+4. Start the app:
+
+   ```bash
+   rails s
+   ```
+
+5. Visit http://localhost:3000/hello_world.
+
+
+### Turning on server rendering
+
+With the code from running the React on Rails generator above:
+
+1. Edit `app/views/hello_world/index.html.erb` and set the `prerender` option to `true`.
+2. Refresh the page.
+
+Below is the line where you turn server rendering on by setting `prerender` to true:
+
+```erb
+<%= react_component("HelloWorld", props: @hello_world_props, prerender: false) %>
+```
+
+Note, if you got an error in your console regarding "ReferenceError: window is not defined",
+then you need to edit `config/webpacker.yml` and set `hmr: false` and `inline: false`.
+See [rails/webpacker PR 2644](https://github.com/rails/webpacker/pull/2644) for a fix for this
+issue.
+
+## Basic Usage
+
+### Configuration
+
+* Configure `config/initializers/react_on_rails.rb`. You can adjust some necessary settings and defaults. See file [docs/basics/configuration.md](https://www.shakacode.com/react-on-rails/docs/guides/configuration/) for documentation of all configuration options.
+* Configure `config/webpacker.yml`. If you used the generator and the default webpacker setup, you don't need to touch this file. If you are customizing your setup, then consult the [spec/dummy/config/webpacker.yml](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/config/webpacker.yml) example or the official default [webpacker.yml](https://github.com/rails/webpacker/blob/master/lib/install/config/webpacker.yml).
+* Most apps should rely on the rails/webpacker setup for Webpack. v6 of rails/webpacker includes support for v5 of webpack.
+
+## Including your React Component on your Rails Views
+
+- React component are rendered via your Rails Views. Here's an ERB sample:
+
+  ```erb
+  <%= react_component("HelloWorld", props: @some_props) %>
+  ```
+
+- **Server-Side Rendering**: Your react component is first rendered into HTML on the server. Use the **prerender** option:
+
+  ```erb
+  <%= react_component("HelloWorld", props: @some_props, prerender: true) %>
+  ```
+
+- The `component_name` parameter is a string matching the name you used to expose your React component globally. So, in the above examples, if you had a React component named "HelloWorld", you would register it with the following lines:
+
+  ```js
+  import ReactOnRails from 'react-on-rails';
+  import HelloWorld from './HelloWorld';
+  ReactOnRails.register({ HelloWorld });
+  ```
+
+  Exposing your component in this way is how React on Rails is able to reference your component from a Rails view. You can expose as many components as you like, as long as their names do not collide. See below for the details of how you expose your components via the react_on_rails webpack configuration. You may call `ReactOnRails.register` many times.
+
+- `@some_props` can be either a hash or JSON string. This is an optional argument assuming you do not need to pass any options (if you want to pass options, such as `prerender: true`, but you do not want to pass any properties, simply pass an empty hash `{}`). This will make the data available in your component:
+
+  ```ruby
+    # Rails View
+    <%= react_component("HelloWorld", props: { name: "Stranger" }) %>
+  ```
+
+- This is what your HelloWorld.js file might contain. The railsContext is always available for any parameters that you _always_ want available for your React components. It has _nothing_ to do with the concept of the [React Context](https://reactjs.org/docs/context.html). See [Render-Functions and the RailsContext](https://www.shakacode.com/react-on-rails/docs/guides/render-functions-and-railscontext/) for more details on this topic.
+
+  ```js
+  import React from 'react';
+
+  export default (props, railsContext) => {
+    // Note wrap in a function to make this a React function component
+    return () => (
+      <div>
+        Your locale is {railsContext.i18nLocale}.<br/>
+        Hello, {props.name}!
+      </div>
+    );
+  };
+  ```
+
+See the [View Helpers API](https://www.shakacode.com/react-on-rails/docs/api/view-helpers-api/) for more details on `react_component` and its sibling function `react_component_hash`.
+
+## Globally Exposing Your React Components
+
+For the React on Rails view helper `react_component` to use your React components, you will have to **register** them in your JavaScript code.
+
+Use modules just as you would when using Webpack and React without Rails. The difference is that instead of mounting React components directly to an element using `React.render`, you **register your components to ReactOnRails and then mount them with helpers inside of your Rails views**.
+
+This is how to expose a component to the `react_component` view helper.
+
+```javascript
+  // app/javascript/packs/hello-world-bundle.js
+  import HelloWorld from '../components/HelloWorld';
+  import ReactOnRails from 'react-on-rails';
+  ReactOnRails.register({ HelloWorld });
+```
+
+#### Different Server-Side Rendering Code (and a Server-Specific Bundle)
+
+You may want different code for your server-rendered components running server side versus client side. For example, if you have an animation that runs when a component is displayed, you might need to turn that off when server rendering. One way to handle this is conditional code like `if (window) { doClientOnlyCode() }`.
+
+Another way is to use a separate webpack configuration file that can use a different server side entry file, like  'serverRegistration.js' as opposed to 'clientRegistration.js.' That would set up different code for server rendering.
+
+For details on techniques to use different code for client and server rendering, see: [How to use different versions of a file for client and server rendering](https://forum.shakacode.com/t/how-to-use-different-versions-of-a-file-for-client-and-server-rendering/1352). (_Requires creating a free account._)
+
+## Specifying Your React Components: Register directly or use render-functions
+
+You have two ways to specify your React components. You can either register the React component (either function or class component) directly, or you can create a function that returns a React component, which we using the name of a "render-function". Creating a render-function allows:
+
+1. You to have access to the `railsContext`. See [documentation for the railsContext](https://www.shakacode.com/react-on-rails/docs/guides/render-functions-and-railscontext/) in terms of why you might need it. You **need** a Render-Function to access the `railsContext`.
+2. You can use the passed-in props to initialize a redux store or set up react-router.
+3. You can return different components depending on what's in the props.
+
+Note, the return value of a **Render-Function** should be either a React Function or Class Component, or an object representing server rendering results.
+
+**Do not return a React Element (JSX).**
+
+ReactOnRails will automatically detect a registered Render-Function by the fact that the function takes
+more than 1 parameter. In other words, if you want the ability to provide a function that returns the
+React component, then you need to specify at least a second parameter. This is the `railsContext`.
+If you're not using this parameter, declare your function with the unused param:
+
+```js
+const MyComponentGenerator = (props, _railsContext) => {
+  if (props.print) {
+    // This is a React FunctionComponent because it is wrapped in a function.
+    return () => <H1>{JSON.stringify(props)}</H1>;
+  }
+}
+```
+
+Thus, there is no difference between registering a React Function Component or class Component versus a "Render-Function." Just call `ReactOnRails.register`.
+
+## react_component_hash for Render-Functions
+
+Another reason to use a Render-Function is that sometimes in server rendering, specifically with React Router, you need to return the result of calling ReactDOMServer.renderToString(element). You can do this by returning an object with the following shape: { renderedHtml, redirectLocation, error }. Make sure you use this function with `react_component_hash`.
+
+For server rendering, if you wish to return multiple HTML strings from a Render-Function, you may return an Object from your Render-Function with a single top-level property of `renderedHtml`. Inside this Object, place a key called `componentHtml`, along with any other needed keys. An example scenario of this is when you are using side effects libraries like [React Helmet](https://github.com/nfl/react-helmet). Your Ruby code will get this Object as a Hash containing keys componentHtml and any other custom keys that you added:
+
+```js
+{ renderedHtml: { componentHtml, customKey1, customKey2} }
+```
+
+For details on using react_component_hash with react-helmet, see [our react-helmet documentation](https://www.shakacode.com/react-on-rails/docs/additional-reading/react-helmet/).
+
+## Error Handling
+
+* All errors from ReactOnRails will be of type ReactOnRails::Error.
+* Prerendering (server rendering) errors get context information for HoneyBadger and Sentry for easier debugging.
+
+## I18n
+
+React on Rails provides an option for automatic conversions of Rails `*.yml` locale files into `*.json` or `*.js*.
+See the [How to add I18n](https://www.shakacode.com/react-on-rails/docs/guides/i18n/) for a summary of adding I18n.

data/docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md

@@ -0,0 +1,104 @@
+# HMR and Hot Reloading with the webpack-dev-server
+
+The webpack-dev-server provides:
+
+1. Speedy compilation of client side assets
+2. Optional HMR which means that the page will reload automatically when after
+   compilation completes. Note, some developers do not like this, as you'll
+   abruptly lose any tweaks within the Chrome development tools.
+3. Optional hot-reloading. The older react-hot-loader has been deprecated in 
+   favor of [fast-refresh](https://reactnative.dev/docs/fast-refresh).
+   For use with webpack, see **Client Side rendering and HMR using react-refresh-webpack-plugin** section bellow or visit [react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin) for additional details.
+
+If you are ***not*** using server-side rendering (***not*** using `prerender: true`),
+then you can follow all the regular docs for using the `bin/webpacker-dev-server` 
+during development.
+
+# Server Side Rendering with the Default rails/webpacker bin/webpacker-dev-server
+
+If you are using server-side rendering, then you have a couple options. The
+recommended technique is to have a different webpack configuration for server
+rendering.  
+
+## If you use the same Webpack setup for your server and client bundles 
+If you do use the webpack-dev-server for prerendering, be sure to set the
+`config/initializers/react_on_rails.rb` setting of 
+
+```
+  config.same_bundle_for_client_and_server = true
+```
+
+`dev_server.hmr` maps to [devServer.hot](https://webpack.js.org/configuration/dev-server/#devserverhot).
+This must be false if you're using the webpack-dev-server for client and server bundles.
+ 
+`dev_server.inline` maps to [devServer.inline](https://webpack.js.org/configuration/dev-server/#devserverinline).
+This must also be false.
+
+If you don't configure these two to false, you'll see errors like:
+
+* "ReferenceError: window is not defined" (if hmr is true)
+* "TypeError: Cannot read property 'prototype' of undefined" (if inline is true)
+
+# Client Side rendering with HMR using react-refresh-webpack-plugin
+## Basic installation
+To enable HMR functionality you have to use `./bin/webpacker-dev-server`
+1. In `config/webpacker.yml` set **hmr** and **inline** `dev_server` properties to true. 
+    ```
+    dev_server:
+      https: false
+      host: localhost
+      port: 3035
+      public: localhost:3035
+      hmr: true
+      # Inline should be set to true if using HMR
+      inline: true
+    ```
+
+2. Add react refresh packages:
+    ` yarn add @pmmmwh/react-refresh-webpack-plugin react-refresh -D`
+
+3. HMR is for use with the webpack-dev-server, so we only add this for the webpack-dev-server.
+   ```
+   const { devServer } = require('shakapacker')
+
+   const isWebpackDevServer = process.env.WEBPACK_DEV_SERVER
+
+   //plugins
+   if (isWebpackDevServer) {
+     environment.plugins.append(
+       'ReactRefreshWebpackPlugin',
+       new ReactRefreshWebpackPlugin({
+         overlay: {
+           sockPort: devServer.port
+         }
+       })
+     )
+   }
+    ```
+    We added overlay.sockedPort option in `ReactRefreshWebpackPlugin` to match the webpack dev-server port specified in config/webpacker.yml. Thats way we make sockjs works properly and suppress error in browser console `GET http://localhost:[port]/sockjs-node/info?t=[xxxxxxxxxx] 404 (Not Found)`. 
+
+4. Add react-refresh plugin in `babel.config.js`
+```
+  module.export = function(api) {
+    return {
+      plugins: [process.env.WEBPACK_DEV_SERVER && 'react-refresh/babel'].filter(Boolean)
+    }
+  }
+```
+That's it :).
+Now Browser should reflect .js along with .css changes without reloading.
+
+If by some reason plugin doesn't work you could revert changes and left only devServer hmr/inline to true affecting only css files.
+
+These plugins are working and tested with 
+   - babel 7
+   - webpacker 5
+   - bootstrap 4
+   - jest 26
+   - core-js 3
+   - node 12.10.0
+   - react-refresh-webpack-plugin@0.4.1
+   - react-refresh 0.8.3 
+   - react_on_rails 11.1.4 
+   
+   configuration.

data/docs/{outdated → guides}/how-react-on-rails-works.md

@@ -1,21 +1,21 @@
 # How React on Rails Works (with rails/webpacker)
 
-*Note, older versions of React on Rails pushed the Webpack bundles through the Asset Pipeline. This older method has *many* disadvantages, such as broken sourcemaps, performance issues, etc. If you need help migrating to the current way of bypassing the Asset Pipeline, [email Justin](mailto:justin@shakacode.com).* 
+*Note, older versions of React on Rails pushed the Webpack bundles through the Asset Pipeline. This older method has *many* disadvantages, such as broken sourcemaps, performance issues, etc. If you need help migrating to the current way of bypassing the Asset Pipeline, [email Justin](mailto:justin@shakacode.com).*
 
-Webpack is used to generate JavaScript and CSS "bundles" directly to your `/public` directory. [rails/webpacker](https://github.com/rails/webpacker) provides view helpers to access the Webpack generated (and fingerprinted) JS and CSS. These files totally skip the Rails asset pipeline. You are responsible for properly configuring your Webpack output. You will either use the standard Webpack configuration (*recommended*) or the `rails/webpacker` setup for Webpack. 
+Webpack is used to generate JavaScript and CSS "bundles" directly to your `/public` directory. [rails/webpacker](https://github.com/rails/webpacker) provides view helpers to access the Webpack generated (and fingerprinted) JS and CSS. These files totally skip the Rails asset pipeline. You are responsible for properly configuring your Webpack output. You will either use the standard Webpack configuration (*recommended*) or the `rails/webpacker` setup for Webpack.
 
 Ensure these generated bundle files are in your `.gitignore`, as you never want to add the large compiled bundles to git.
 
-Inside your Rails views, you can now use the `react_component` helper method provided by React on Rails. You can pass props directly to the react component helper. 
+Inside your Rails views, you can now use the `react_component` helper method provided by React on Rails. You can pass props directly to the react component helper.
 
-Optionally, you can also initialize a Redux store with the view or controller helper `redux_store` so that the redux store can be shared amongst multiple React components. 
+Optionally, you can also initialize a Redux store with the view or controller helper `redux_store` so that the redux store can be shared amongst multiple React components.
 
 ## Client-Side Rendering vs. Server-Side Rendering
 
 In most cases, you should use the `prerender: false` (default behavior) with the provided `react_component` helper method to render the React component from your Rails views. In some cases, such as when SEO is vital, or many users will not have JavaScript enabled, you can enable server-rendering by passing `prerender: true` to your helper, or you can simply change the default in `config/initializers/react_on_rails`.
 
 Now the server will interpret your JavaScript. The default is to use [ExecJS](https://github.com/rails/execjs) and pass the resulting HTML to the client. If you want to maximize the perfomance of your server rendering, then you want to use React on Rails Pro which uses NodeJS to do the server rendering. See the [docs for React on Rails Pro](https://github.com/shakacode/react_on_rails/wiki).
- 
+
 ## HTML Source Code
 
 If you open the HTML source of any web page using React on Rails, you'll see the 3 parts of React on Rails rendering:
@@ -28,17 +28,17 @@ You can see all this on the source for [reactrails.com](https://www.reactrails.c
 
 ## Building the Bundles
 
-Each time you change your client code, you will need to re-generate the bundles (the webpack-created JavaScript files included in application.js). The included example Foreman `Procfile.dev` files will take care of this for you by starting a webpack process with the watch flag. This will watch your JavaScript code files for changes. Alternately, the `rails/webpacker` library also can ensure that your bundles are built. 
+Each time you change your client code, you will need to re-generate the bundles (the webpack-created JavaScript files included in application.js). The included example Foreman `Procfile.dev` files will take care of this for you by starting a webpack process with the watch flag. This will watch your JavaScript code files for changes. Alternately, the `rails/webpacker` library also can ensure that your bundles are built.
 
-For example, you might create a [Procfile.dev](spec/dummy/Procfile.dev).
+For example, you might create a [Procfile.dev](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/Procfile.dev).
 
-On production deployments that use asset precompilation, such as Heroku deployments, `rails/webpacker`, by default, will automatically run webpack to build your JavaScript bundles, running the command `bin/webpack` in your app.
+On production deployments that use asset precompilation, such as Heroku deployments, `rails/webpacker`, by default, will automatically run webpack to build your JavaScript bundles, running the command `bin/webpacker` in your app.
 
 However, if you want to run a custom command to run webpack to build your bundles, then you will:
-1. Ensure you do not have a `config/webpack/production.js` file
-1. Define `config.build_production_command` in your [config/initializers/react_on_rails.rb](docs/basics/configuration.md)
+1. Define `config.build_production_command` in your [config/initializers/react_on_rails.rb](https://www.shakacode.com/react-on-rails/docs/guides/configuration/)
 
 Then React on Rails modifies the `assets:precompile` task to run your `build_production_command`.
 
 If you have used the provided generator, these bundles will automatically be added to your `.gitignore` to prevent extraneous noise from re-generated code in your pull requests. You will want to do this manually if you do not use the provided generator.
 
+You can stop React on Rails from modifying or creating the `assets:precompile` task, by setting a `REACT_ON_RAILS_PRECOMPILE` environment variable to `no`, `false`, `n` or `f`.

data/docs/guides/how-to-conditionally-server-render-based-on-device-type.md

@@ -0,0 +1,39 @@
+# How to conditionally render server side based on the device type
+
+In general, we want to use CSS to do mobile responsive layouts.
+
+However, sometimes we want to have layouts sufficiently different that we can't do this via CSS. If we didn't do server rendering, we can check the device type on the client side. However, if we're doing server rendering, we need to send this data to the client code from the Rails server so that the server rendering can account for this.
+
+Here's an example:
+
+## config/initializers/react_on_rails.rb
+```ruby
+module RenderingExtension
+  # Return a Hash that contains custom values from the view context that will get passed to
+  # all calls to react_component and redux_store for rendering
+  def self.custom_context(view_context)
+    if view_context.controller.is_a?(ActionMailer::Base)
+      {}
+    else
+      {
+        desktop: !(view_context.browser.device.tablet? || view_context.browser.device.mobile?),
+        tablet: view_context.browser.device.tablet?,
+        mobile: view_context.browser.device.mobile? || false
+      }
+    end
+  end
+end
+
+# Shown below are the defaults for configuration
+ReactOnRails.configure do |config|
+  # See https://github.com/shakacode/react_on_rails/blob/master/docs/guides/configuration.md for the rest
+
+  # This allows you to add additional values to the Rails Context. Implement one static method
+  # called `custom_context(view_context)` and return a Hash.
+  config.rendering_extension = RenderingExtension
+end
+```
+
+Note, full details of the React on Rails confguration are [here in docs/basics/configuration.md](https://shakacode.com/react-on-rails/docs/guides/configuration/).
+
+See the doc file [docs/basics/generator-functions-and-railscontext.md](https://shakacode.com/react-on-rails/docs/guides/generator-functions-and-railscontext/#rails-context) for how your client-side code uses the device information

data/docs/guides/how-to-use-different-files-for-client-and-server-rendering.md

@@ -0,0 +1,98 @@
+## How to use different versions of a file for client and server rendering
+
+There are 3 main ways to use different code for server vs. client rendering.
+
+## A. Using different Entry Points
+Many projects will have different entry points for client and server rendering. This only works for a top-level entry point such as the entry point for a react-router app component.
+
+Your Client Entry can look like this:
+
+```js
+import ReactOnRails from 'react-on-rails';
+import App from './ClientApp';
+ReactOnRails.register({ App })
+```
+
+So your Server Entry can look like:
+
+```js
+import ReactOnRails from 'react-on-rails';
+import App from './ServerApp';
+ReactOnRails.register({ App })
+```
+
+Note that the only difference is on the second line of each of these examples.
+
+## B. Two Options for Using Webpack Resolve Alias in the Webpack Config
+Per [Webpack Docs](https://webpack.js.org/configuration/resolve/#resolve-alias).
+
+### 1. Update `webpack/set-resolve.js` to have a different resolution for the exact file:
+
+```js
+function setResolve(builderConfig, webpackConfig) {
+
+  // Use a different resolution for Client and Server file
+  let SomeJsFile;
+  if (builderConfig.serverRendering) {
+    SomeJsFile = path.resolve(__dirname, "../bundles/SomeJsFileServer");
+  } else {
+    SomeJsFile = path.resolve(__dirname, "../bundles/SomeJsFileClient");
+  }
+
+ const resolve = {
+    alias: {
+      ... // blah blah
+      SomeJsFile,
+      ... // blah blah
+    },
+```
+
+Then you have this import:
+
+```js
+import SomeJsFile from 'SomeJsFile';
+```
+
+### 2. Use a different resolution for the right directory of client or server files:
+
+#### a. Update `webpack/set-resolve.js` to have something like:
+```js
+function setResolve(builderConfig, webpackConfig) {
+
+  // Use a different resolution for Client and Server file
+  let variant;
+  if (builderConfig.serverRendering) {
+    variant = path.resolve(__dirname, "../bundles/variant/ClientOnly");
+  } else {
+    variant = path.resolve(__dirname, "../bundles/variant/serverOnly");
+  }
+
+ const resolve = {
+    alias: {
+      ... // blah blah
+      variant
+      ... // blah blah
+    },
+```
+
+#### b. Add different versions of the file to the `bundles/variant/ClientOnly` and `bundles/variant/ServerOnly` directories
+
+#### c. Use the `variant` in import in a file that can be used both for client and server rendering:
+
+```js
+import SomeJsFile from 'variant/SomeJsFile';
+import AnotherJsFile from 'variant/AnotherJsFile';
+```
+
+## C. Conditional code that can check if `window` is defined.
+
+This is probably the ugliest and hackiest way to do this, but it's quick! Essentially you wrap code that cannot execute server side in a conditional:
+
+```js
+if (window) { // window should be falsy on the server side
+  doSomethingClientOnly();
+  
+  // or do an import
+  const foobar = require('foobar').default;
+}
+```

data/docs/{basics → guides}/installation-into-an-existing-rails-app.md

@@ -1,22 +1,29 @@
 # Getting Started with an existing Rails app
 
-**Also consult the instructions for installing on a fresh Rails app**, see the [React on Rails Basic Tutorial](../../docs/tutorial.md).
+**Also consult the instructions for installing on a fresh Rails app**, see the [React on Rails Basic Tutorial](https://www.shakacode.com/react-on-rails/docs/guides/tutorial/).
 
-**If you have rails-5 API only project**, first [convert the rails-5 API only app to rails app](#convert-rails-5-api-only-app-to-rails-app) before [getting started](#getting-started-with-an-existing-rails-app).
+**If you have rails-5 API only project**, first [convert the rails-5 API only app to rails app](https://www.shakacode.com/react-on-rails/docs/rails/convert-rails-5-api-only-app-to-rails-app/).
 
-1. Add the following to your Gemfile and `bundle install`. We recommend fixing the version of React on Rails, as you will need to keep the exact version in sync with the version in your `client/package.json` file.
+1. Add the following to your Gemfile and `bundle install`. We recommend fixing the version of React on Rails, as you will need to keep the exact version in sync with the version in your `package.json` file.
 
    ```ruby
    gem "react_on_rails", "12.0.0" # Update to the current version
    gem "webpacker", "~> 5"
    ```
 
-2. Run the following 2 commands to install Webpacker with React. Note, if you are using an older version of Rails than 5.1, you'll need to install webpacker with React per the instructions [here](https://github.com/rails/webpacker).
+1. Add the webpacker and react_on_rails gems
+_Use the latest version for react_on_rails._
 
+```
+bundle add webpacker                 
+bundle add react_on_rails --version=12.0.4 --strict
+```
+
+2. Run the following 2 commands to install Webpacker with React. Note, if you are using an older version of Rails than 5.1, you'll need to install webpacker with React per the instructions [here](https://github.com/rails/webpacker).
 
    ```bash
-   $ bundle exec rails webpacker:install
-   $ bundle exec rails webpacker:install:react
+   bundle exec rails webpacker:install
+   bundle exec rails webpacker:install:react
    ```
 
 3. Commit this to git (or else you cannot run the generator unless you pass the option `--ignore-warnings`).
@@ -45,7 +52,7 @@
 
 ## Installation
 
-See the [Installation Overview](docs/outdated/manual-installation-overview.md) for a concise set summary of what's in a React on Rails installation.
+See the [Installation Overview](https://www.shakacode.com/react-on-rails/docs/additional-details/manual-installation-overview/) for a concise set summary of what's in a React on Rails installation.
 
 
 ## NPM