react_on_rails 12.2.0 → 12.5.0

data/docs/{basics → guides}/configuration.md

@@ -66,24 +66,26 @@ ReactOnRails.configure do |config|
   # defaults to "" (top level)
   config.node_modules_location = "client" # If using webpacker you should use "".
 
-  # 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.
-  # Note, if you want to use this command then you should remove the file
-  # config/webpack/production.js
-  # If that file exists, React on Rails thinks that you'll use the rails/webpacker bin/webpack compiler.
+  # If you're using the standard rails/webpacker configuration of webpack, then rails/webpacker
+  # will automatically modify or create an assets:precompile task to build your assets. If so,
+  # set this value to nil.  Alternatively, you can specify `config.build_production_command` 
+  # to have react_on_rails invoke a command for you during assets:precompile.
+  # The command is either a script or a module containing a class method `call`
+  # In this example, the module BuildProductionCommand would have a class method `call`.
   config.build_production_command = "RAILS_ENV=production bin/webpack"
 
-  # Alternatively, you can also specify a module containing a class method `call` 
-  # In this example, the module BuildProductionCommand would have a class method `call`.
   # See bottom for an example of the BuildProductionCommand module.
   # config.build_production_command = BuildProductionCommand
-   
+  # If you wish to utilize ReactOnRailsPro production bundle caching logic, then use
+  # config.build_production_command = ReactOnRailsPro::AssetsPrecompile
+  # and be sure to check ReactOnRailsPro's configuration documentation!
+
   ################################################################################
   ################################################################################
   # SERVER RENDERING OPTIONS
   ################################################################################
   # This is the file used for server rendering of React when using `(prerender: true)`
-  # If you are never using server rendering, you should set this to "".
+  # If you are not using server rendering, you should set this to `nil`.
   # Note, there is only one server bundle, unlike JavaScript where you want to minimize the size
   # of the JS sent to the client. For the server rendering, React on Rails creates a pool of
   # JavaScript execution instances which should handle any component requested.

data/docs/{basics → guides}/deployment.md

@@ -1,4 +1,4 @@
 # Deployment
 
 - `rails/webpacker` puts the necessary precompile steps automatically in the rake precompile step.
-- See the [Heroku Deployment](https://www.shakacode.com/react-on-rails/docs/deployment/heroku-deployment) doc for specifics regarding Heroku. The information for Heroku may apply to other deployments.
+- See the [Heroku Deployment](https://www.shakacode.com/react-on-rails/docs/deployment/heroku-deployment/) doc for specifics regarding Heroku. The information for Heroku may apply to other deployments.

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/{basics → guides}/how-react-on-rails-works.md

@@ -35,9 +35,10 @@ For example, you might create a [Procfile.dev](https://github.com/shakacode/reac
 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.
 
 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](https://www.shakacode.com/react-on-rails/docs/basics/configuration)
+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,8 +1,8 @@
 # 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](https://www.shakacode.com/react-on-rails/docs/basics/tutorial).
+**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 `package.json` file.
 
@@ -52,7 +52,7 @@ bundle add react_on_rails --version=12.0.4 --strict
 
 ## 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.
+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

data/docs/{rails-webpacker-react-integration-options.md → guides/rails-webpacker-react-integration-options.md}

@@ -13,7 +13,7 @@ These gems provide advanced integration of React with [rails/webpacker](https://
 | [react-rails](https://github.com/reactjs/react-rails)  | ✅ | ✅ |  | | | | |
 | [webpacker-react](https://github.com/renchap/webpacker-react) | ✅ | | | | | | |
 
-Note, Node SSR for React on Rails requires [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro).
+Note, Node SSR for React on Rails requires [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/).
 
 ---
 

data/docs/guides/react-on-rails-overview.md

@@ -0,0 +1,30 @@
+# React on Rails
+
+React on Rails integrates Rails with (server rendering of) Facebook's [React](https://github.com/facebook/react) front-end framework.
+
+---
+
+# Project Objective
+
+To provide a high performance framework for integrating Ruby on Rails with React via the [**Webpacker**](https://github.com/rails/webpacker) gem especially in regards to React Server-Side Rendering for better SEO and improved performance.
+
+# Features and Why React on Rails?
+
+Given that [`rails/webpacker`](https://github.com/rails/webpacker/) gem already provides basic React integration, why would you use "React on Rails"?
+
+1. Easy passing of props directly from your Rails view to your React components rather than having your Rails view load and then make a separate request to your API.
+1. Tight integration with [rails/webpacker](https://github.com/rails/webpacker).
+1. Server-Side Rendering (SSR), often used for SEO crawler indexing and UX performance, is not offered by `rails/webpacker`.
+1. Support for HMR for a great developer experience.
+1. Supports latest versions of React with hooks.
+1. [Redux](https://github.com/reactjs/redux) and [React Router](https://github.com/ReactTraining/react-router#readme) integration including server-side-rendering.
+1. [Internationalization (I18n) and (localization)](https://www.shakacode.com/react-on-rails/docs/guides/i18n/)
+1. A supportive community. This [web search shows how live public sites are using React on Rails](https://publicwww.com/websites/%22react-on-rails%22++-undeveloped.com+depth%3Aall/).
+1. [ReScript (Reason ML) Support](https://github.com/shakacode/reason-react-on-rails-example).
+
+See the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) for an example of a live implementation and code.
+----
+
+## Prerequisites
+
+Ruby on Rails >=5 and rails/webpacker 4.2+.

data/docs/{basics → guides}/react-server-rendering.md

@@ -1,6 +1,6 @@
 # React Server Rendering
 
-See also [Client vs. Server Rendering](https://www.shakacode.com/react-on-rails/docs/basics/client-vs-server-rendering).
+See also [Client vs. Server Rendering](https://www.shakacode.com/react-on-rails/docs/guides/client-vs-server-rendering/).
 
 ## What is the easiest way to setup a webpack configuration for server-side-rendering?
 See the example webpack setup here: [github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh](https://github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh).
@@ -13,7 +13,7 @@ During the Rails rendering of HTML per a browser request, the Rails server will
 
 The default JavaScript interpretter is [ExecJS](https://github.com/rails/execjs). 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).
 
-See [this note](https://www.shakacode.com/react-on-rails/docs/basics/client-vs-server-rendering).
+See [this note](https://www.shakacode.com/react-on-rails/docs/guides/client-vs-server-rendering/).
 
 ## How do you do Server Rendering with React on Rails?
 1. The `react_component` view helper method provides the `prerender:` option to switch on or off server rendering.

data/docs/{basics → guides}/rspec-configuration.md

@@ -1,5 +1,5 @@
 # RSpec Configuration
-_Click [here for minitest](https://www.shakacode.com/react-on-rails/docs/basics/minitest-configuration)_
+_Click [here for minitest](https://www.shakacode.com/react-on-rails/docs/guides/minitest-configuration/)_
 
 # If your webpack configurations correspond to rails/webpacker's default setup
 If you're able to configure your webpack configuration to be run by having your webpack configuration
@@ -9,7 +9,7 @@ compiled by webpack before running tests and during production deployment:
 1. **Use rails/webpacker's compile option**: Configure your `config/webpacker.yml` so that `compile: true` is for `test` and `production`
    environments. Ensure that your `source_path` is correct, or else `rails/webpacker` won't correctly
    detect changes.
-2. **Use the react_on_rails settings and helpers**. Use the settings in `config/initializers/react_on_rails.rb`. Refer to [docs/configuration](https://www.shakacode.com/react-on-rails/docs/basics/configuration).
+2. **Use the react_on_rails settings and helpers**. Use the settings in `config/initializers/react_on_rails.rb`. Refer to [docs/configuration](https://www.shakacode.com/react-on-rails/docs/guides/configuration/).
 
 ```yml
   config.build_test_command = "NODE_ENV=test RAILS_ENV=test bin/webpack"

data/docs/{basics → guides}/tutorial.md

@@ -1,12 +1,10 @@
 # React on Rails Basic Tutorial
 
------
-
 **November 11, 2020**: See the example repo of [React on Rails Tutorial With SSR, HMR fast refresh, and TypeScript](https://github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh) for a new way to setup the creation of your SSR bundle with `rails/webpacker`. This file will be update shortly. Most of it is still relevant.
 
 -----
 
-*Updated for Ruby 2.7.1, Rails 6.0.3.1, and React on Rails v12.0.0*
+*Updated for Ruby 2.7.1, Rails 6.0.3.1, React on Rails v12.5.0, and Webpacker v6*
 
 This tutorial guides you through setting up a new or existing Rails app with **React on Rails**, demonstrating Rails + React + Redux + Server Rendering.
 
@@ -44,7 +42,7 @@ gem install foreman             # download and install Foreman
 ```
 
 ## Create a new Ruby on Rails App
-Then we need to create a fresh Rails application with webpacker react support as following.
+Then we need to create a fresh Rails application as following.
 
 First be sure to run `rails -v` and check you are using Rails 5.1.3 or above. If you are using an older version of Rails, you'll need to install webpacker with react per the instructions [here](https://github.com/rails/webpacker).
 
@@ -53,10 +51,9 @@ cd <directory where you want to create your new Rails app>
 
 # Any name you like for the rails app
 # Skip javascript so will add that next and get the current version
-rails new --skip-sprockets -J --skip-turbolinks test-react-on-rails-v12-no-sprockets
+rails new --skip-sprockets --skip-turbolinks --javascript=webpack test-react-on-rails
 
 cd test-react-on-rails
-bundle
 ```
 
 ## Add the webpacker and react_on_rails gems
@@ -65,22 +62,21 @@ of both the gem and npm package. In other words, don't use the `^` or `~` in the
 _Use the latest version for react_on_rails._
 
 ```
-gem 'react_on_rails', '12.0.4'         # prefer exact gem version to match npm version
+gem 'react_on_rails', '12.5.0'         # prefer exact gem version to match npm version
 ```
 
 Note: The latest released React On Rails version is considered stable. Please use the latest
 version to ensure you get all the security patches and the best support.
 
 ```bash
-bundle add webpacker                 
-bundle add react_on_rails --version=12.0.4 --strict
+bundle add webpacker --git=https://github.com/rails/webpacker.git
+bundle add react_on_rails --version=12.5.0 --strict
 ```
 
 ## Run the webpacker generator
 
-```
+```terminal
 bundle exec rails webpacker:install
-bundle exec rails webpacker:install:react
 ```
 
 Let's commit everything before installing React on Rails.
@@ -99,20 +95,24 @@ Install React on Rails: `rails generate react_on_rails:install`. You need to fir
 Note, using `redux` is no longer recommended as the basic installer uses React Hooks.
 If you want the redux install: `rails generate react_on_rails:install --redux`
 
+The generator will add `mini_racer`'s latest version. If you're using linux & encounter issues installing `libv8`, here's [a common solution](https://github.com/rubyjs/mini_racer/issues/218).
+
 ```
 rails generate react_on_rails:install
 ```
 
-Then run server with a static client bundle. Static means that the bundle is saved in your
-public/webpack/packs directory.
+Enter `a` to replace all configuration files required by the project.
+
+Then run the server with one of the following options:
 
+## Running with HMR
 ```
 foreman start -f Procfile.dev
 ```
 
-## To run with the webpack-dev-server:
+## Running without HMR, statically creating the bundles
 ```
-foreman start -f Procfile.dev-hmr
+foreman start -f Procfile.dev-static
 ```
 
 Visit [http://localhost:3000/hello_world](http://localhost:3000/hello_world) and see your **React On Rails** app running!
@@ -252,6 +252,8 @@ heroku open
 
 and you will see your live app and you can share this URL with your friends. Congrats!
 
+A deployed version of the project `spec/dummy` which demonstrates several uses of `react_on_rails` is available on heroku [through this link](https://ror-spec-dummy.herokuapp.com/)
+
 ## Turning on Server Rendering
 
 You can turn on server rendering by simply changing the `prerender` option to `true`:
@@ -292,8 +294,8 @@ versus with server rendering:
 
 For more details on server rendering, see:
 
-  + [Client vs. Server Rendering](https://www.shakacode.com/react-on-rails/docs/basics/client-vs-server-rendering)
-  + [React Server Rendering](https://www.shakacode.com/react-on-rails/docs/basics/react-server-rendering)
+  + [Client vs. Server Rendering](https://www.shakacode.com/react-on-rails/docs/guides/client-vs-server-rendering/)
+  + [React Server Rendering](https://www.shakacode.com/react-on-rails/docs/guides/react-server-rendering/)
 
 ## Moving from the Rails default `/app/javascript` to the recommended `/client` structure
 
@@ -314,7 +316,7 @@ mv app/javascript client
 
 ## Using HMR with the rails/webpacker setup
 
-Start the app using `foreman start -f Procfile.dev-hmr`.
+Start the app using `foreman start -f Procfile.dev`.
 
 When you change a JSX file and save, the browser will automatically refresh!
 

data/docs/{basics → guides}/upgrading-react-on-rails.md

@@ -25,7 +25,7 @@ If you still need that feature, please file an issue.
 In order to solve the issues regarding React Hooks compatibility, the number of parameters
 for functions is used to determine if you have a Render-Function that will get invoked to
 return a React component, or you are registering a React component defined by a function.
-Please see [Render-Functions and the Rails Context](https://www.shakacode.com/react-on-rails/docs/basics/render-functions-and-railscontext) for
+Please see [Render-Functions and the Rails Context](https://www.shakacode.com/react-on-rails/docs/guides/render-functions-and-railscontext/) for
 more information on what a Render-Function is.
 
 ##### Update required for registered functions taking exactly 2 params.

data/docs/{basics → guides}/webpack-configuration.md

@@ -22,7 +22,7 @@ A key decision in your use React on Rails is whether you go with the rails/webpa
 
 ## Option 1: Default Generator Setup: rails/webpacker app/javascript
 
-Typical rails/webpacker apps have a standard directory structure as documented [here](https://github.com/rails/webpacker/blob/5-x-stable/docs/recommended-project-structure.md). If you follow the steps in the the [basic tutorial](https://www.shakacode.com/react-on-rails/docs/basics/tutorial), you will see this pattern in action. In order to customize the Webpack configuration, you need to consult with the [rails/webpacker Webpack configuration](https://www.shakacode.com/react-on-rails/docs/javascript/webpack).
+Typical rails/webpacker apps have a standard directory structure as documented [here](https://github.com/rails/webpacker/blob/5-x-stable/docs/recommended-project-structure.md). If you follow the steps in the the [basic tutorial](https://www.shakacode.com/react-on-rails/docs/guides/tutorial/), you will see this pattern in action. In order to customize the Webpack configuration, you need to consult with the [rails/webpacker Webpack configuration](https://www.shakacode.com/react-on-rails/docs/javascript/webpack/).
 
 The *advantage* of using rails/webpacker to configure Webpack is that there is very little code needed to get started and you don't need to understand really anything about Webpack customization.