Skip to content

Commit b9b16ce

Browse files
authored
Update docs for migrating from react-rails (#1577)
1 parent d4e4812 commit b9b16ce

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed
Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
11
## Migrate From react-rails
2-
If you are using [react-rails](https://github.com/reactjs/react-rails) in your project, it is pretty simple to migrate to [react_on_rails](https://github.com/shakacode/react_on_rails).
32

4-
- Remove the 'react-rails' gem from your Gemfile.
3+
In this guide, it is assumed that you have upgraded the `react-rails` project to use `shakapacker` version 7. To this end, check out [Shakapacker v7 upgrade guide](https://github.com/shakacode/shakapacker/tree/master/docs/v7_upgrade.md). Upgrading `react-rails` to version 3 can make the migration smoother but it is not required.
54

6-
- Remove the generated lines for react-rails in your application.js file.
5+
1. Update Deps
76

8-
```
9-
//= require react
10-
//= require react_ujs
11-
//= require components
12-
```
7+
1. Replace `react-rails` in `Gemfile` with the latest version of `react_on_rails` and run `bundle install`.
8+
2. Remove `react_ujs` from `package.json` and run `yarn install`.
9+
3. Commit changes!
1310

14-
- Follow our [getting started guide](https://www.shakacode.com/react-on-rails/docs/getting-started/).
11+
2. Run `rails g react_on_rails:install` but do not commit the change. `react_on_rails` installs node dependencies and also creates sample react component, Rails view/controller, and update `config/routes.rb`.
1512

16-
Note: If you have components from react-rails you want to use, then you will need to port them into react_on_rails which uses webpack instead of the asset pipeline.
13+
3. Adapt the project: Check the changes and carefully accept, reject, or modify them as per your project's needs. Besides changes in `config/shakapacker` or `babel.config` which are project-specific, here are the most noticeable changes to address:
1714

15+
1. Check webpack config files at `config/webpack/*`. If coming from `react-rails` v3, the changes are minor since you have already made separate configurations for client and server bundles. The most important change here is to notice the different names for the server bundle entry file. You may choose to stick with `server_rendering.js` or use `server-bundle.js` which is the default name in `react_on_rails`. The decision made here, affects the other steps.
16+
17+
2. In `app/javascript` directory you may notice some changes.
18+
19+
1. `react_on_rails` by default uses `bundles` directory for the React components. You may choose to rename `components` into `bundles` to follow the convention.
20+
21+
2. `react_on_rails` uses `client-bundle.js` and `server-bundle.js` instead of `application.js` and `server_rendering.js`. There is nothing special about these names. It can be set to use any other name (as mentioned above). If you too choose to follow the new names, consider updating the relevant `javascript_pack_tag` in your Rails views.
22+
23+
3. Update the content of these files to register your React components for client or server-side rendering. Checking the generated files by `react_on_rails` installation process should give enough hints.
24+
25+
3. Check Rails views. In `react_on_rails`, `react_component` view helper works slightly differently. It takes two arguments: the component name, and options. Props is one of the options. Take a look at the following example:
26+
27+
```diff
28+
- <%= react_component('Post', { title: 'New Post' }, { prerender: true }) %>
29+
+ <%= react_component('Post', { props: { title: 'New Post' }, prerender: true }) %>
30+
```
31+
32+
You can also check [react-rails-to-react-on-rails](https://github.com/shakacode/react-rails-example-app/tree/react-rails-to-react-on-rails) branch on [react-rails example app](https://github.com/shakacode/react-rails-example-app) for an example of migration from `react-rails` v3 to `react_on_rails` v13.4.

0 commit comments

Comments
 (0)