react_on_rails 12.0.1 → 13.0.0

data/docs/guides/webpack-configuration.md

@@ -0,0 +1,42 @@
+# Webpack Configuration: custom setup for Webpack or rails/webpacker?
+
+## Webpack vs. rails/webpacker
+
+[Webpack](https://webpack.js.org) is the JavaScript npm package that prepares all your client-side assets. The Rails asset pipeline used to be the preferable way to prepare client-side assets.
+
+[rails/webpacker](https://github.com/rails/webpacker) is the Ruby gem that mainly gives us 2 things:
+
+1. View helpers for placing the webpack bundles on your Rails views. React on Rails depends on these view helpers.
+2. A layer of abstraction on top of Webpack customization. The base setup works great for the client side webpack configuration.
+
+To get a deeper understanding of `rails/webpacker`, watch [RailsConf 2020 CE - Webpacker, It-Just-Works, But How? by Justin Gordon](https://youtu.be/sJLoOpc5LD8)
+
+Per the example repo [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),
+you should consider keeping your codebase mostly consistent with the defaults for [rails/webpacker](https://github.com/rails/webpacker).
+
+# React on Rails
+
+Version 9 of React on Rails added support for the rails/webpacker view helpers so that Webpack produced assets would no longer pass through the Rails asset pipeline. As part of this change, React on Rails added a configuration option to support customization of the node_modules directory. This allowed React on Rails to support the rails/webpacker configuration of the Webpack configuration.
+
+A key decision in your use React on Rails is whether you go with the rails/webpacker default setup or the traditional React on Rails setup of putting all your client side files under the `/client` directory. While there are technically 2 independent choices involved, the directory structure and the mechanism of Webpack configuration, for simplicity sake we'll assume that these choices go together.
+
+## 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/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.
+
+## Option 2: Traditional React on Rails using the /client directory
+
+Until version 9, all React on Rails apps used the `/client` directory for configuring React on Rails in terms of the configuration of Webpack and location of your JavaScript and Webpack files, including the node_modules directory. Version 9 changed the default to `/` for the `node_modules` location using this value in `config/initializers/react_on_rails.rb`: `config.node_modules_location`.
+
+You can access values in the `config/webpacker.yml`
+
+```js
+const { config, devServer } = require('shakapacker');
+```
+
+You will want consider using some of the same values set in these files:
+
+* https://github.com/rails/webpacker/blob/master/package/environments/base.js
+* https://github.com/rails/webpacker/blob/master/package/environments/development.js

data/docs/home.md

@@ -0,0 +1,23 @@
+# React on Rails
+
+## Details
+1. [Overview](https://www.shakacode.com/react-on-rails/docs/guides/react-on-rails-overview/)
+1. [Getting Started](https://www.shakacode.com/react-on-rails/docs/guides/getting-started/)
+1. [How React on Rails Works](https://www.shakacode.com/react-on-rails/docs/guides/how-react-on-rails-works/)
+1. [Webpack Configuration](https://www.shakacode.com/react-on-rails/docs/guides/webpack-configuration/)
+1. [View Helpers API](https://www.shakacode.com/react-on-rails/docs/api/view-helpers-api/)
+1. [Caching and Performance: React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/).
+1. [Deployment](https://www.shakacode.com/react-on-rails/docs/guides/deployment/).
+
+## Changes and Upgrades
+1. [CHANGELOG.md](https://github.com/shakacode/react_on_rails/tree/master/CHANGELOG.md)
+2. [Upgrading React on Rails](https://www.shakacode.com/react-on-rails/docs/guides/upgrading-react-on-rails/#upgrading-to-v12).
+
+## Example Apps
+1. [spec/dummy](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy) example repo for a simple configuration of webpack via the rails/webpacker gem
+that supports SSR.
+2. 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`.
+3. Live, [open source](https://github.com/shakacode/react-webpack-rails-tutorial), example of this gem, see [reactrails.com](http://reactrails.com).
+
+# Other Resources
+1. RailsConf 2020 talk: [Webpacker, It-Just-Works, But How?](http://railsconf.com/2020/video/justin-gordon-webpacker-it-just-works-but-how)

data/docs/{outdated → javascript}/code-splitting.md

@@ -1,6 +1,6 @@
 # Code Splitting (Outdated)
 
-_Note: This document is outdated._ Please email [justin@shakacode.com](mailto:justin@shakacode.com) 
+_Note: This document is outdated._ Please email [justin@shakacode.com](mailto:justin@shakacode.com)
 if you would be interested in help with code splitting using
 [loadable-components.com](https://loadable-components.com/docs) with React on Rails.
 
@@ -68,7 +68,7 @@ ReactOnRails.register({
   RouterApp,
 });
 ```
-Note that you should not register a renderer on the server, since there won't be a domNodeId when we're server rendering. Note that the `RouterApp` imported by `serverRegistration.js` is from a different file. For an example of how to set up an app for server rendering, see the [react router docs](../additional-reading/react-router.md).
+Note that you should not register a renderer on the server, since there won't be a domNodeId when we're server rendering. Note that the `RouterApp` imported by `serverRegistration.js` is from a different file. For an example of how to set up an app for server rendering, see the [react router docs](https://www.shakacode.com/react-on-rails/docs/javascript/react-router/).
 
 #### RouterAppRenderer.jsx
 ```jsx
@@ -117,8 +117,8 @@ There's an implemented example of code splitting in the `spec/dummy` folder of t
 
 See:
 
-- [spec/dummy/client/app/startup/clientRegistration.jsx](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/app/startup/clientRegistration.jsx)
-- [spec/dummy/client/app/startup/serverRegistration.jsx](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/app/startup/serverRegistration.jsx)
+- [spec/dummy/client/app/startup/client-bundle.js](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/app/startup/client-bundle.js)
+- [spec/dummy/client/app/packs/server-bundle.js](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/app/packs/server-bundle.js)
 - [spec/dummy/client/app/startup/DeferredRenderAppClient](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/app/startup/DeferredRenderAppClient.jsx)<-- Code splitting implemented here
 - [spec/dummy/client/app/startup/DeferredRenderAppServer.jsx](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/app/startup/DeferredRenderAppServer.jsx)
 - [spec/dummy/client/app/components/DeferredRender.jsx](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/app/components/DeferredRender.jsx)
@@ -150,7 +150,7 @@ config = {
 
 This causes Webpack to prepend the code chunk filename with `/assets/` in the request url. The react on rails sets up the webpack config to put webpack bundles in `app/assets/javascripts/webpack`, and modifies `config/initializers/assets.rb` so that rails detects the bundles. This means that when we prepend the request url with `/assets/`, rails will know what webpack is asking for.
 
-See [rails-assets.md](docs/outdated/rails-assets.md) to learn more about static assets.
+See [our rails assets documentation](https://www.shakacode.com/react-on-rails/docs/outdated/rails-assets/) to learn more about static assets.
 
 If you forget to set the public path, webpack will request the code chunk at `/{filename}`. This will cause the request to be handled by the Rails router, which will send back a 404 response, assuming that you don't have a catch-all route. In your javascript console, you'll get the following error:
 

data/docs/{additional-reading → javascript}/converting-from-custom-webpack-config-to-rails-webpacker-config.md

@@ -1,10 +1,10 @@
 # Converting from Custom Webpack Config to Rails Webpacker Config
 
-1. Compare your package.json and the dependencies in https://github.com/rails/webpacker/blob/master/package.json#L14-L48
-  and avoid any duplicates. We don't want different versions of the same packages. 
+1. Compare your package.json and the dependencies in https://github.com/rails/webpacker/blob/master/package.json
+  and avoid any duplicates. We don't want different versions of the same packages.
   We want the versions from rails/webpacker unless we specifically want to override them.
 2. Search the rails/webpacker repo for anything you're not sure about in terms of package names.
-3. run `bin/webpack` and make sure there are zero errors
+3. run `bin/webpacker` and make sure there are zero errors
 4. update webpack plugins and loaders to current or close to current
-5. Make sure that your bin/webpack and bin/webpacker match the latest on 
+5. Make sure that your bin/webpacker and bin/webpacker match the latest on
 https://github.com/rails/webpacker/tree/master/lib/install/bin

data/docs/{additional-reading → javascript}/images.md

@@ -1,8 +1,8 @@
 # Images
 
-1. leading slash necessary on the 
+1. leading slash necessary on the
    a. Option name for the file-loader and url-loader (todo reference)
-   b. Option publicPath for the output (todo reference) 
+   b. Option publicPath for the output (todo reference)
 
 
 
@@ -39,13 +39,13 @@ const assetLoaderRules = [
 
 
 
-A full example can be found at [spec/dummy/client/app/components/ImageExample/ImageExample.jsx](../../spec/dummy/client/app/components/ImageExample/ImageExample.jsx)
+A full example can be found at [spec/dummy/client/app/components/ImageExample/ImageExample.jsx](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/app/components/ImageExample/ImageExample.jsx)
 
-You are free to use images either in image tags or as background images in SCSS files. You can 
+You are free to use images either in image tags or as background images in SCSS files. You can
 use a "global" location of /client/app/assets/images or a relative path to your JS or SCSS file, as
 is done with CSS modules.
 
-**images** is a defined alias, so "images/foobar.jpg" would point to the file at 
+**images** is a defined alias, so "images/foobar.jpg" would point to the file at
 `/client/app/assets/images/foobar.jpg.`
 
 ```
@@ -55,4 +55,3 @@ is done with CSS modules.
     },
   },
 ```
-

data/docs/{articles.md → misc/articles.md}

@@ -6,7 +6,7 @@
 * [Webpacker Lite: Why Fork Webpacker?](https://blog.shakacode.com/webpacker-lite-why-fork-webpacker-f0a7707fac92)
 * [React on Rails, 2000+ 🌟 Stars](https://medium.com/shakacode/react-on-rails-2000-stars-32ff5cfacfbf#.6gmfb2gpy)
 * [The React on Rails Doctrine](https://medium.com/@railsonmaui/the-react-on-rails-doctrine-3c59a778c724)
-* [Simple Tutorial](docs/tutorial.md).
+* [Simple Tutorial](https://www.shakacode.com/react-on-rails/docs/guides/tutorial/).
 
 ## Videos
 

data/docs/misc/doctrine.md

@@ -4,7 +4,7 @@ By Justin Gordon, January 26, 2016
 
 This document is an extension and complement to [The Rails Doctrine](http://rubyonrails.org/doctrine/). If you haven't read that document, I suggest you do so first.
 
-As stated in the [React on Rails README](../../README.md), the project objective is to provide an opinionated and optimal framework for integrating **Ruby on Rails** with modern JavaScript tooling and libraries. When considering what goes into **react_on_rails**, we ask ourselves, is the functionality related to the intersection of using Rails and with modern JavaScript? A good example is view helper integration of React components on a Rails view. If the answer is yes, then the functionality belongs right here. In other cases, we're releasing separate npm packages or Ruby gems. For example, we needed an easy way to integrate [Twitter Bootstrap](http://getbootstrap.com/) with Webpack, and we released the [npm bootstrap-loader](https://github.com/shakacode/bootstrap-loader/). 
+As stated in the [React on Rails README](https://www.shakacode.com/react-on-rails/docs/), the project objective is to provide an opinionated and optimal framework for integrating **Ruby on Rails** with modern JavaScript tooling and libraries. When considering what goes into **react_on_rails**, we ask ourselves, is the functionality related to the intersection of using Rails and with modern JavaScript? A good example is view helper integration of React components on a Rails view. If the answer is yes, then the functionality belongs right here. In other cases, we're releasing separate npm packages or Ruby gems. For example, we needed an easy way to integrate [Twitter Bootstrap](http://getbootstrap.com/) with Webpack, and we released the [npm bootstrap-loader](https://github.com/shakacode/bootstrap-loader/).
 
 Besides the project objective, let's stick with the "Rails Doctrine" and keep the following in mind.
 
@@ -19,15 +19,14 @@ The React on Rails setup provides several key components related to front-end de
 6. Happiness for us is actively participating in open source, so we want to be where the action is, which is with the npm libraries on github.com.
 7. You can get set up on React on Rails **FAST** using our application generator.
 8. By placing all client-side development inside of the `/client` directory, pure JavaScript developers can productively do development separate from Rails. Instead of Rails APIs, stub APIs on an express server can provide a simple backend, allowing for rapid iteration of UI prototypes.
-9. Just because we're not relying on the Rails asset pipeline for ES6 conversion does not mean that we're deploying Rails apps in any different way. We still use the asset pipeline to include our Webpack compiled JavaScript. This only requires a few small modifications, as explained in our doc [Heroku Deployment](docs/basics/heroku-deployment.md).
+9. Just because we're not relying on the Rails asset pipeline for ES6 conversion does not mean that we're deploying Rails apps in any different way. We still use the asset pipeline to include our Webpack compiled JavaScript. This only requires a few small modifications, as explained in [our heroku deployment documentation](https://www.shakacode.com/react-on-rails/docs/deployment/heroku-deployment/).
 
 ## Convention over Configuration
 * React on Rails has taken the hard work out of figuring out the JavaScript tooling that works best with Rails. Not only could you spend lots of time researching different tooling, but then you'd have to figure out how to splice it all together. This is where a lot of "JavaScript fatigue" comes from. The following keep the code clean and consistent:
-* [Style Guide](../coding-style/style.md)
-* [linters](../contributor-info/linters.md)
-* [Recommended Project Structure](../basics/recommended-project-structure.md)
+* [Style Guide](https://www.shakacode.com/react-on-rails/docs/misc/style/)
+* [linters](https://www.shakacode.com/react-on-rails/docs/contributor-info/linters/)
 
-We're big believers in this quote from the Rails Doctrine: 
+We're big believers in this quote from the Rails Doctrine:
 
 > The same goes even when you understand how all the pieces go together. When there’s an obvious next step for every change, we can scoot through the many parts of an application that is the same or very similar to all the other applications that went before it. A place for everything and everything in its place. Constraints liberate even the most able minds.
 

data/docs/outdated/deferred-rendering.md

@@ -0,0 +1,39 @@
+# Deferred Rendering
+
+Please see [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/] if you are interested in code splitting using
+[loadable-components.com](https://loadable-components.com/docs) with React on Rails.
+
+-----
+
+What is code splitting? From the webpack documentation:
+
+> For big web apps it’s not efficient to put all code into a single file, especially if some blocks of code are only required under some circumstances. Webpack has a feature to split your codebase into “chunks” which are loaded on demand. Some other bundlers call them “layers”, “rollups”, or “fragments”. This feature is called “code splitting”.
+
+## Server Rendering and Code Splitting
+
+Let's say you're requesting a page that needs to fetch a code chunk from the server before it's able to render. If you do all your rendering on the client side, you don't have to do anything special. However, if the page is rendered on the server, you'll find that React will spit out the following error:
+
+> Warning: React attempted to reuse markup in a container but the checksum was invalid. This generally means that you are using server rendering and the markup generated on the server was not what the client was expecting. React injected new markup to compensate which works but you have lost many of the benefits of server rendering. Instead, figure out why the markup being generated is different on the client or server:
+
+> (client) <!-- react-empty: 1 -
+
+> (server) <div data-reactroot="
+<!--This comment is here because the comment beginning on line 13 messes up Sublime's markdown parsing-->
+
+Different markup is generated on the client than on the server. Why does this happen? When you register a component or Render-Function with `ReactOnRails.register`, React on Rails will by default render the component as soon as the page loads. However, code splitting requires that components render at a later time when the JavaScript chunks have loaded.
+
+## Solution
+
+To prevent this, you have to wait until the code chunk is fetched before doing the initial render on the client side. To accomplish this, react on rails allows you to register a renderer. This works just like registering a Render-Function, except that the function you pass takes three arguments: `renderer(props, railsContext, domNodeId)`, and is responsible for calling `ReactDOM.render` or `ReactDOM.hydrate` to render the component to the DOM. React on rails will automatically detect when a Render-Function takes three arguments, and will **not** call `ReactDOM.render` or `ReactDOM.hydrate`, instead allowing you to control the initial render yourself. Note, you have to be careful to call `ReactDOM.hydrate` rather than `ReactDOM.render` if you are are server rendering.
+
+
+## Server vs. Client Code Caveats
+
+If you're going to try to do code splitting with server rendered routes, you'll probably need to use seperate route definitions for client and server to prevent code splitting from happening for the server bundle. The server bundle should be one file containing all the JavaScript code. This will require you to have seperate webpack configurations for client and server.
+
+Do not attempt to register a renderer function on the server. Instead, register either a Render-Function or a component. If you register a renderer in the server bundle, you'll get an error when react on rails tries to server render the component.
+
+
+## React on Rails Pro
+[React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/] includes a complete setup using this technique for code splitting using
+[loadable-components.com](https://loadable-components.com/docs) with React on Rails.

data/docs/outdated/rails-assets-relative-paths.md

@@ -77,7 +77,7 @@ Note: _You can output these files in the asset pipeline wherever you see fit. My
 
 Lastly, we will set the publicPath to our file(s). This will be the endpoint on our rails web server that you can visit to reach the asset (if you don't know how this works, read the [intro](#using-webpack-bundled-assets-with-the-rails-asset-pipeline)). If you've been following the previous steps, you know that we set our outputPath for our assets to be absolute at `app/assets/webpack/webpack-assets/`, which your rails app should end up hosting at `/assets/webpack-assets/file-name+hash.ext` when the server is run.
 
-Note: _If you're having a hard time figuring out what an asset's path will be on your rails server, simply run `rake assets:precompile` and `cd public/`. The path from there to your file will then be the path/url on your web server to that asset. On top of this, it is also a good idea to check out [this doc](docs/outdated/rails-assets.md) to understand how `react_on_rails` allows us to access these files after precompilation, when Rails applies another hash onto the asset._
+Note: _If you're having a hard time figuring out what an asset's path will be on your rails server, simply run `rake assets:precompile` and `cd public/`. The path from there to your file will then be the path/url on your web server to that asset. On top of this, it is also a good idea to check out [this doc](https://www.shakacode.com/react-on-rails/docs/outdated/rails-assets/) to understand how `react_on_rails` allows us to access these files after precompilation, when Rails applies another hash onto the asset._
 
 Our publicPath setting will match the path to our outputted assets on our rails web server. Given our assets in this example will be outputted to `/app/assets/webpack/webpack-assets/` and hosted at `/assets/webpack-assets/`, our publicPath would be:
 
@@ -179,7 +179,7 @@ module.exports = {
         // The important stuff
         test: /\.(jpg|jpeg|png)(\?.*)?$/, // Load only .jpg .jpeg, and .png files
         use: {
-          loader: 'file-loader', 
+          loader: 'file-loader',
           options: {
             name: '[name][md5:hash].[ext]', // Name of bundled asset
             outputPath: 'webpack-assets/', // Output location for assets. Final: `app/assets/webpack/webpack-assets/`
@@ -192,4 +192,4 @@ module.exports = {
 };
 ```
 
-If you'd like to understand how react_on_rails handles these bundled assets after asset precompilation and in production mode, check out: [Rails Assets](docs/outdated/rails-assets.md).
+If you'd like to understand how react_on_rails handles these bundled assets after asset precompilation and in production mode, check out: [Rails Assets](https://www.shakacode.com/react-on-rails/docs/outdated/rails-assets/).

data/docs/outdated/rails-assets.md

@@ -13,24 +13,24 @@ CSS and fonts for CSS. However, this applies to any file that might be processed
 Webpack file loader.
 
 ## The Problem
-To understand the problem, it helps to read this article: 
+To understand the problem, it helps to read this article:
 [What is fingerprinting and why should I care](http://guides.rubyonrails.org/asset_pipeline.html#what-is-fingerprinting-and-why-should-i-care-questionmark)
 Basically, when Rails prepares assets for production deployments, it also adds a digest
-to the file names. E.g., `img1.jpg` becomes `img1-dbu097452jf2v2.jpg`. 
+to the file names. E.g., `img1.jpg` becomes `img1-dbu097452jf2v2.jpg`.
 
-When compiling its native css Rails transforms all urls and links to digested 
-versions, i.e. `background-image: image-url(img1.jpg)` becomes 
-`background-image: url(img1-dbu097452jf2v2.jpg)`. However this doesn't happen for js and 
-css files compiled by webpack on the client side, because they don't use 
+When compiling its native css Rails transforms all urls and links to digested
+versions, i.e. `background-image: image-url(img1.jpg)` becomes
+`background-image: url(img1-dbu097452jf2v2.jpg)`. However this doesn't happen for js and
+css files compiled by webpack on the client side, because they don't use
 `image-url` and `asset-url`. Without some fix, these assets would fail to load.
 
-When Webpack's client JavaScript uses images in render methods, e.g. `<img src='...' />` or 
+When Webpack's client JavaScript uses images in render methods, e.g. `<img src='...' />` or
 in css, e.g. `background-image: url(...)` The code (such as the CSS) generated by the Webpack
 will have the Webpack digested name (MD5 hash). Since the Webpack generated CSS expects
 just one level of "digesting", this "double-digesting" from Rails will cause such these assets
 fail to load.
 
-_If you are interested in learning how to use assets in your React components, read this doc: [Webpack, the Asset Pipeline, and Using Assets w/ React](../additional-reading/rails-assets-relative-paths.md)._
+_If you are interested in learning how to use assets in your React components, read this doc: [Webpack, the Asset Pipeline, and Using Assets w/ React](https://www.shakacode.com/react-on-rails/docs/outdated/rails-assets-relative-paths/)_
 
 ## The Solution: Symlink Original File Names to New File Names
 _Note, this solution was removed in v14. If you're intersted in this symlink solution, please create

data/docs/outdated/rails3.md

@@ -1,9 +1,9 @@
 # Rails 3
 
-* Please let us know if you find any issues with Rails 3. 
+* Please let us know if you find any issues with Rails 3.
 * Rails 3 is confirmed to work up with versions up to 6.8.x.
 * We are not testing it for new releases. If you find an issue, you will have to submit a PR to get it fixed.
 
 ## Known Issues
 
-1. If you do not skip bootstrap for the generator, you cannot generate a working app, as bootstrap-sass does not not support Rails 3, or at least the version we're using.
+1. If you do not skip bootstrap for the generator, you cannot generate a working app, as bootstrap-sass does not support Rails 3, or at least the version we're using.

data/docs/{additional-reading → rails}/convert-rails-5-api-only-app.md

@@ -16,4 +16,4 @@ Rails will start creating the app and will skip the files you have already creat
 3. If it is removeing some of your code then press "n" and add all additions manually
 ```
 
-3. Run `bundle install` and follow [the instructions for installing into an existing Rails app](../basics/installation-into-an-existing-rails-app.md).*
+3. Run `bundle install` and follow [the instructions for installing into an existing Rails app](https://www.shakacode.com/react-on-rails/docs/guides/installation-into-an-existing-rails-app/)

data/docs/{additional-reading → rails}/rails-engine-integration.md

@@ -14,24 +14,15 @@ s.add_dependency 'react_on_rails', '~> 6'
 ```ruby
 require "react_on_rails"
 ```
-+ In your `lib/tasks/<engine_name>_tasks.rake`:
-```ruby
-Rake.application.remove_task('react_on_rails:assets:compile_environment')
-
-task 'react_on_rails:assets:compile_environment' do
-  path = File.join(YourEngineName::Engine.root, 'client')
-  sh "cd #{path} && #{ReactOnRails.configuration.build_production_command}"
-end
-``` 
 ## In the project including your engine
 
 Place `gem 'react_on_rails', '~> 6'` before the gem pointing at your engine in your gemfile.
 
-This is necessary because React on Rails attaches itself to the rake assets:precompile task. It then uses a direct path to cd into client, which will not exist in the main app that includes your engine. Since you'll always be precompiling assets in the parent app, this will always fail. The workaround then, is to remove the task and replace it with one that goes into your Engine's root. The reason you have to include the react on rails gem before your engine is so that the `react_on_rails:assets:compile_environment` task is defined by the time your engine gets loaded to remove it.
-
 Requiring `react_on_rails` and including the helper will get rid of any issues where react on rails or react_component is undefined.
 
-As far as solving the assets issue, `lib/tasks/assets.rake` in `react_on_rails` would somehow have to know that `react_on_rails` was included in an engine, and decide the path accordingly. This might be impossible, especially in the case of multiple engines using `react_on_rails` in a single application. Another solution would be to detach this rake task from the rails assets:precompile task, and let people use it separately.
+As far as solving the assets issue, `lib/tasks/assets.rake` in `react_on_rails` would somehow have to know that `react_on_rails` was included in an engine, and decide the path accordingly. This might be impossible, especially in the case of multiple engines using `react_on_rails` in a single application.
+
+Another solution would be to detach this rake task from the `rails assets:precompile` task. This can be done by adding `REACT_ON_RAILS_PRECOMPILE=false` to your environment. If you do so, then react assets will have to be bundled separately from `rails assets:precompile`.
 
 # Github Issues
 

data/docs/{additional-reading → rails}/turbolinks.md

@@ -1,4 +1,15 @@
-# Turbolinks
+# Turbolinks and Turbo
+
+## Updated to support Turbo
+* See [PR 1374](https://github.com/shakacode/react_on_rails/pull/1374).
+* Ability to use with Turbo (@hotwired/turbo), as Turbolinks gets obsolete.
+
+To configure turbo the following option can be set:
+  `ReactOnRails.setOptions({ turbo: true })`
+
+Turbo is not auto-detected like older Turbolinks.
+
+*Below docs maybe outdated*
 
 * See [Turbolinks on Github](https://github.com/rails/turbolinks)
 * React on Rails currently supports 2.5.x of Turbolinks and 5.0.0 of Turbolinks 5.
@@ -73,6 +84,7 @@ To turn on tracing of Turbolinks events, put this in your registration file, whe
 ```js
    ReactOnRails.setOptions({
      traceTurbolinks: true,
+     turbo: true,
    });
 ```
 

data/docs/react-on-rails-pro/react-on-rails-pro.md

@@ -0,0 +1,43 @@
+## React on Rails Pro
+
+Support React on Rails development [by becoming a Github sponsor](https://github.com/sponsors/shakacode) and get these benefits:
+
+1. 1-hour per month of support via Slack, PR reviews, and Zoom for React on Rails,
+   React-Rails, rails/webpacker, ReScript (ReasonML), TypeScript, Rust, etc.
+2. React on Rails Pro Software that extends React on Rails with Node server rendering,
+   fragment caching, code-splitting, and other performance enhancements for React on Rails.
+
+See the [React on Rails Pro Support Plan](https://www.shakacode.com/react-on-rails-pro/).
+
+ShakaCode can also help you with your custom software development needs. We specialize in
+marketplace and e-commerce applications that utilize both Rails and React.
+Because we own [HiChee.com](https://hichee.com), we can leverage that code for your app!
+
+Please email Justin Gordon [justin@shakacode.com](mailto:justin@shakacode.com), the
+maintainer of React on Rails, for more information.
+
+### Pro: Fragment Caching
+
+Fragment caching is a [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/) feature. Fragment caching is a **HUGE** performance booster for your apps. Use the `cached_react_component` and `cached_react_component_hash`. The API is the same as `react_component` and `react_component_hash`, but for 2 differences:
+
+1. The `cache_key` takes the same parameters as any Rails `cache` view helper.
+1. The **props** are passed via a block so that evaluation of the props is not done unless the cache is broken. Suppose you put your props calculation into some method called `some_slow_method_that_returns_props`:
+
+```ruby
+<%= cached_react_component("App", cache_key: [@user, @post], prerender: true) do
+  some_slow_method_that_returns_props
+end %>
+```
+
+Such fragment caching saves CPU work for your web server and greatly reduces the request time. It completely skips the evaluation costs of:
+
+1. Database calls to compute the props.
+2. Serialization the props values hash into a JSON string for evaluating JavaScript to server render.
+3. Costs associated with evaluating JavaScript from your Ruby code.
+4. Creating the HTML string containing the props and the server-rendered JavaScript code.
+
+Note, even without server rendering (without step 3 above), fragment caching is still effective.
+
+### Pro: Integration with Node.js for Server Rendering
+
+Default server rendering is done by ExecJS. If you want to use a Node.js server for better performing server rendering, [email justin@shakacode.com](mailto:justin@shakacode.com). ShakaCode has built a premium Node rendering server that is part of [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro).

data/docs/testimonials/testimonials.md

@@ -1,17 +1,17 @@
 # Testimonials
-# [HVMN Testimonial, Written by Paul Benigeri, October 12, 2018](./hvmn.md)
+# [HVMN Testimonial, Written by Paul Benigeri, October 12, 2018](https://www.shakacode.com/react-on-rails/docs/testimonials/hvmn/)
 
 > The price we paid for the consultation + the React on Rails pro license has already been made back a couple of times from hosting fees alone. The entire process was super hands off, and our core team was able to focus on shipping new feature during that sprint.
 
-Full writeup [here](./hvmn.md).
+Full writeup [here](https://www.shakacode.com/react-on-rails/docs/testimonials/hvmn/).
 
 ---
 
-# [Leora from ResortPass](./resortpass.md), December 10, 2018
+# [Leora from ResortPass](https://www.shakacode.com/react-on-rails/docs/testimonials/resortpass/), December 10, 2018
 
-Justin and his team were instrumental in assisting us in setting design foundations and standards for our transition to a react on rails application. Just three months of work with the team at Shaka code and we have a main page of our application server-side rendering at exponentially improved speeds. 
+Justin and his team were instrumental in assisting us in setting design foundations and standards for our transition to a react on rails application. Just three months of work with the team at Shaka code and we have a main page of our application server-side rendering at exponentially improved speeds.
 
-Full writeup [here](./testimonials/resortpass.md).
+Full writeup [here](https://www.shakacode.com/react-on-rails/docs/testimonials/resortpass/).
 
 ---
 
@@ -25,4 +25,4 @@ From Kyle Maune of Cooper Aerial, May 4, 2018
 
 ![image](https://user-images.githubusercontent.com/1118459/40891236-9b0b406e-671d-11e8-80ee-c026dbd1d5a2.png)
 
-For more testimonials, see [Live Projects](PROJECTS.md) and [Kudos](KUDOS.md).
+For more testimonials, see [Live Projects](https://github.com/shakacode/react_on_rails/tree/master/PROJECTS.md) and [Kudos](https://github.com/shakacode/react_on_rails/tree/master/KUDOS.md).

data/lib/generators/react_on_rails/base_generator.rb

@@ -33,7 +33,42 @@ module ReactOnRails
                         app/views/layouts/hello_world.html.erb
                         config/initializers/react_on_rails.rb
                         Procfile.dev
-                        Procfile.dev-hmr]
+                        Procfile.dev-static]
+        base_files.each { |file| copy_file("#{base_path}#{file}", file) }
+      end
+
+      def copy_js_bundle_files
+        base_path = "base/base/"
+        base_files = %w[app/javascript/packs/server-bundle.js
+                        app/javascript/bundles/HelloWorld/components/HelloWorldServer.js
+                        app/javascript/bundles/HelloWorld/components/HelloWorld.module.css]
+        base_files.each { |file| copy_file("#{base_path}#{file}", file) }
+      end
+
+      def copy_webpack_config
+        puts "Adding Webpack config"
+        base_path = "base/base"
+        base_files = %w[babel.config.js
+                        config/webpack/clientWebpackConfig.js
+                        config/webpack/commonWebpackConfig.js
+                        config/webpack/test.js
+                        config/webpack/development.js
+                        config/webpack/production.js
+                        config/webpack/serverWebpackConfig.js
+                        config/webpack/webpack.config.js
+                        config/webpack/webpackConfig.js]
+        config = {
+          message: "// The source code including full typescript support is available at:"
+        }
+        base_files.each do |file|
+          template("#{base_path}/#{file}.tt", file, config)
+        end
+      end
+
+      def copy_webpacker_config
+        puts "Adding Webpacker v6 config"
+        base_path = "base/base/"
+        base_files = %w[config/webpacker.yml]
         base_files.each { |file| copy_file("#{base_path}#{file}", file) }
       end
 
@@ -43,7 +78,24 @@ module ReactOnRails
       end
 
       def add_yarn_dependencies
-        run "yarn add react-on-rails --exact"
+        major_minor_patch_only = /\A\d+\.\d+\.\d+\z/.freeze
+        if ReactOnRails::VERSION.match?(major_minor_patch_only)
+          run "yarn add react-on-rails@#{ReactOnRails::VERSION} --exact"
+        else
+          # otherwise add latest
+          puts "Adding the lastest react-on-rails NPM module. Double check this is correct in package.json"
+          run "yarn add react-on-rails --exact"
+        end
+
+        puts "Adding React dependencies"
+        run "yarn add react react-dom @babel/preset-react prop-types babel-plugin-transform-react-remove-prop-types \
+            babel-plugin-macros"
+
+        puts "Adding CSS handlers"
+        run "yarn add css-loader css-minimizer-webpack-plugin mini-css-extract-plugin style-loader"
+
+        puts "Adding dev dependencies"
+        run "yarn add -D @pmmmwh/react-refresh-webpack-plugin react-refresh"
       end
 
       def append_to_spec_rails_helper
@@ -86,28 +138,28 @@ module ReactOnRails
 
           What to do next:
 
-            - See the documentation on https://github.com/rails/webpacker/blob/master/docs/webpack.md
+            - See the documentation on https://github.com/shakacode/shakapacker#webpack-configuration
               for how to customize the default webpack configuration.
 
             - Include your webpack assets to your application layout.
 
                 <%= javascript_pack_tag 'hello-world-bundle' %>
 
-            - Run `rails s` to start the Rails server and use Webpacker's default lazy compilation.
-
-            - Visit http://localhost:3000/hello_world and see your React On Rails app running!
+            - Run `rails s` to start the Rails server.
 
-            - Run bin/webpack-dev-server to start the Webpack dev server for compilation of Webpack
+            - Run bin/webpacker-dev-server to start the Webpack dev server for compilation of Webpack
               assets as soon as you save. This default setup with the dev server does not work
               for server rendering
 
-            - Alternately, you may turn off compile in config/webpacker.yml and run the foreman
-              command to start the rails server and run webpack in watch mode.
+            - Visit http://localhost:3000/hello_world and see your React On Rails app running!
+
+            - Alternately, run the foreman command to start the rails server and run webpack#{' '}
+              in watch mode.
 
-                foreman start -f Procfile.dev
+                foreman start -f Procfile.dev-static
 
             - To turn on HMR, edit config/webpacker.yml and set HMR to true. Restart the rails server
-              and bin/webpack-dev-server. Or use Procfile.dev-hmr.
+              and bin/webpacker-dev-server. Or use Procfile.dev.
 
             - To server render, change this line app/views/hello_world/index.html.erb to
               `prerender: true` to see server rendering (right click on page and select "view source").
@@ -125,7 +177,7 @@ module ReactOnRails
       # From https://github.com/rails/rails/blob/4c940b2dbfb457f67c6250b720f63501d74a45fd/railties/lib/rails/generators/rails/app/app_generator.rb
       def app_name
         @app_name ||= (defined_app_const_base? ? defined_app_name : File.basename(destination_root))
-                      .tr('\\', "").tr(". ", "_")
+                      .tr("\\", "").tr(". ", "_")
       end
 
       def defined_app_name

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -25,7 +25,7 @@ module ReactOnRails
       end
 
       def copy_tests
-        %w[spec/features/hello_world_spec.rb].each { |file| copy_file(file) }
+        %w[spec/system/hello_world_spec.rb].each { |file| copy_file(file) }
       end
 
       def add_test_related_gems_to_gemfile

data/lib/generators/react_on_rails/generator_helper.rb

@@ -52,4 +52,8 @@ module GeneratorHelper
     empty_directory(parent_directories) unless dest_dir_exists?(parent_directories)
     copy_file source_file, destination_file
   end
+
+  def add_documentation_reference(message, source)
+    "#{message} \n#{source}"
+  end
 end

data/lib/generators/react_on_rails/templates/.eslintrc

@@ -1,5 +1,7 @@
 ---
-extends: eslint-config-shakacode
+extends: 
+  - eslint-config-shakacode
+  - prettier
 
 plugins:
   - react

data/lib/generators/react_on_rails/templates/base/base/Procfile.dev

@@ -1,9 +1,5 @@
+# Procfile for development using HMR
 # You can run these commands in separate shells
-web: rails s -p 3000
-
-# Next line runs a watch process with webpack to compile the changed files.
-# When making frequent changes to client side assets, you will prefer building webpack assets
-# upon saving rather than when you refresh your browser page.
-# Note, if using React on Rails localization you will need to run
-# `bundle exec rake react_on_rails:locale` before you run bin/webpack
-client: sh -c 'rm -rf public/packs/* || true && bin/webpack -w'
+rails: bundle exec rails s -p 3000
+wp-client: HMR=true bin/webpacker-dev-server
+wp-server: HMR=true SERVER_BUNDLE_ONLY=yes bin/webpacker --watch