react-on-rails

---

These are the docs for React on Rails 12. To see the version 11 docs, click here.

About

React on Rails integrates Rails with (server rendering of) Facebook's React front-end framework.

This project is maintained by the software consulting firm ShakaCode. We focus on Ruby on Rails applications with React front-ends, often using TypeScript or ReScript (ReasonML). We also build React Native apps and Gatsby sites. See our recent work for examples of what we do. ShakaCode.com (HiChee.com) is hiring developers that like working on open-source.

Interested in optimizing your webpack setup for React on Rails including code splitting with react-router and loadable-components with server-side rendering for SEO and hot-reloading for developers? We did this for Popmenu, lowering Heroku costs 20-25% while getting a 73% decrease in average response times. Check out React on Rails Pro.

Feel free to contact Justin Gordon, [e-mail], maintainer of React on Rails, for more information.

Documentation

See the documentation at shakacode.com/react-on-rails/docs.

Project Objective

To provide a high performance framework for integrating Ruby on Rails with React via the 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 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.
2. Tight integration with rails/webpacker.
3. Server-Side Rendering (SSR), often used for SEO crawler indexing and UX performance, is not offered by rails/webpacker.
4. Redux and React Router integration with server-side-rendering.
5. Internationalization (I18n) and (localization)
6. A supportive community. This web search shows how live public sites are using React on Rails.
7. Reason ML Support.

See Rails/Webpacker React Integration Options for comparisons to other gems.

See the react-webpack-rails-tutorial for an example of a live implementation and code.

ShakaCode Forum Premium Content

Requires creating a free account.

• How to use different versions of a file for client and server rendering
• How to conditionally render server side based on the device type

Prerequisites

Ruby on Rails >=5 and rails/webpacker 4.2+.

Support

• Click to join React + Rails Slack.

• Subscribe for announcements of new releases of React on Rails and of our latest blog articles and tutorials.
• forum.shakacode.com: Post your questions
• @railsonmaui on Twitter
• See NEWS.md for more notes over time.
• See Projects using and KUDOS for React on Rails. Please submit yours! Please edit either page or email us and we'll add your info. We also love stars as it helps us attract new users and contributors.
• See NEWS.md for more notes over time.

Contributing

Bug reports and pull requests are welcome. See Contributing to get started, and the list of help wanted issues.

Supporters

The following companies support this open source project, and ShakaCode uses their products! Justin writes React on Rails on RubyMine. We use Scout to monitor the live performance of HiChee.com, Rails AutoScale to scale the dynos of HiChee, and HoneyBadger to monitor application errors. We love BrowserStack to solve problems with oddball browsers. Status Hero keeps the team posted on daily progress; it's so much better than live standups.

ShakaCode's favorite project tracking tool is ClubHouse. If you want to try ClubHouse and get 2 months free beyond the 14-day trial period, click here to use ShakaCode's referral code. We're participating in their awesome triple-sided referral program, which you can read about here. By using our referral code you'll be supporting ShakaCode and, thus, React on Rails!

Aloha and best wishes from Justin and the ShakaCode team!

Work with Us

ShakaCode is hiring passionate software engineers to work on our projects, including HiChee.

License

The gem is available as open source under the terms of the MIT License.

Changelog

[12.4.0] - 2021-09-22

Added

• ScoutAPM tracing support for server rendering PR 1379 by justin808.

• Ability to stop React on Rails from modifying or creating the assets:precompile task. PR 1371 by justin808. Thanks to elstgav for the suggestion!

• Added the ability to have render functions return a promise to be awaited by React on Rails Pro Node Renderer. PR 1380 by judahmeek