README.md in react-rails-2.5.0 vs README.md in react-rails-2.6.0
- old
+ new
@@ -1,16 +1,16 @@
# React-Rails
[](http://rubygems.org/gems/react-rails)
[](https://www.npmjs.com/package/react_ujs)
[](https://travis-ci.org/reactjs/react-rails)
-[
+[]()
React-Rails is a flexible tool to use [React](http://facebook.github.io/react/) with Rails. The benefits:
* Automatically renders React server-side and client-side
-* Supports Webpacker 3.x, 2.x, 1.1+
+* Supports Webpacker 4.x, 3.x, 2.x, 1.1+
* Supports Sprockets 4.x, 3.x, 2.x
* Lets you use [JSX](http://facebook.github.io/react/docs/jsx-in-depth.html), [ES6](http://es6-features.org/), [TypeScript](https://www.typescriptlang.org/), [CoffeeScript](http://coffeescript.org/)
A source code example utilizing React-Rails: https://github.com/BookOfGreg/react-rails-example-app
@@ -38,10 +38,14 @@
- [Use with JBuilder](#use-with-jbuilder)
- [Camelize Props](#camelize-props)
- [Upgrading](#upgrading)
- [2.3 to 2.4](#23-to-24)
- [Common Errors](#common-errors)
+ - [During installation](#during-installation)
+ - [Undefined Set](#undefined-set)
+ - [Using TheRubyRacer](#using-therubyracer)
+ - [HMR](#hmr)
- [Related Projects](#related-projects)
- [Contributing](#contributing)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -62,11 +66,11 @@
$ rails new my-app
$ cd my-app
```
##### 2) Add `webpacker` and `react-rails` to your gemfile:
-```
+```ruby
gem 'webpacker'
gem 'react-rails'
```
##### 3) Now run the installers:
@@ -81,11 +85,11 @@
- `app/javascript/components/` directory for your React components
- [`ReactRailsUJS`](#ujs) setup in `app/javascript/packs/application.js`
- `app/javascript/packs/server_rendering.js` for [server-side rendering](#server-side-rendering)
##### 4) Link the JavaScript pack in Rails view using `javascript_pack_tag` [helper](https://github.com/rails/webpacker#usage):
-```
+```erb
<!-- application.html.erb in Head tag below turbolinks -->
<%= javascript_pack_tag 'application' %>
```
##### 5) Generate your first component:
@@ -100,11 +104,11 @@
Note: Your component is added to `app/javascript/components/` by default.
##### 7) [Render it in a Rails view](#view-helper):
-```
+```erb
<!-- erb: paste this in view -->
<%= react_component("HelloWorld", { greeting: "Hello from react-rails." }) %>
```
##### 8) Lets Start the app:
@@ -190,11 +194,11 @@
## Use with Asset Pipeline
`react-rails` provides a pre-bundled React.js & a UJS driver to the Rails asset pipeline. Get started by adding the `react-rails` gem:
-```
+```ruby
gem 'react-rails'
```
And then install the react generator:
@@ -625,10 +629,11 @@
- global find+replace `React.Prop` -> `Prop`
- add `import PropTypes from 'prop-types'` (Webpacker only)
- re-run `bundle exec rails webpacker:install:react` to update npm packages (Webpacker only)
## Common Errors
+### During installation
1) While using installers.(rails webpacker:install:react && rails webpacker:install)
Error:
```
public/packs/manifest.json. Possible causes:
1. You want to set webpacker.yml value of compile to true for your environment
@@ -648,11 +653,29 @@
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt-get update && sudo apt-get install yarn
yarn install
```
+### Undefined Set
+```
+ExecJS::ProgramError (identifier 'Set' undefined):
+
+(execjs):1
+```
+If you see any variation of this issue, see [Using TheRubyRacer](#using-therubyracer)
+
+### Using TheRubyRacer
+TheRubyRacer [hasn't updated LibV8](https://github.com/cowboyd/therubyracer/blob/master/therubyracer.gemspec#L20) (The library that powers Node.js) from v3 in 2 years, any new features are unlikely to work.
+
+LibV8 itself is already [beyond version 7](https://github.com/cowboyd/libv8/releases/tag/v7.3.492.27.1) therefore many serverside issues are caused by old JS engines and fixed by using an up to date one such as [MiniRacer](https://github.com/discourse/mini_racer) or [TheRubyRhino](https://github.com/cowboyd/therubyrhino) on JRuby.
+
+### HMR
+HMR is possible with this gem as it does just pass through to Webpacker. Please open an issue to let us know tips and tricks for it to add to the wiki.
+
+One example: [Stack Overflow answer with Babel and Webpacker config](https://stackoverflow.com/a/54846330/193785)
+
## Related Projects
- [webpacker-react](https://github.com/renchap/webpacker-react): Integration of React with Rails utilizing Webpack with Hot Module Replacement (HMR).
- [The Free React on Rails Course](https://learnetto.com/users/hrishio/courses/the-free-react-on-rails-5-course) A free video course which teaches the basics of React and how to get started using it in Rails with `react-rails`.
- [react\_on\_rails](https://github.com/shakacode/react_on_rails): Integration of React with Rails utilizing Webpack, Redux, React-Router.
@@ -662,10 +685,10 @@
## Contributing
🎉 Thanks for taking the time to contribute! 🎉
-With 2 Million+ downloads of the react-rails Gem and another 100k+ downloads of react_ujs on NPM, you're helping the biggest React + Rails community!
+With 5 Million+ downloads of the react-rails Gem and another 2 Million+ downloads of react_ujs on NPM, you're helping the biggest React + Rails community!
By contributing to React-Rails, you agree to abide by the [code of conduct](https://github.com/reactjs/react-rails/blob/master/CODE_OF_CONDUCT.md).
You can always help by submitting patches or triaging issues, even offering reproduction steps to issues is incredibly helpful!