react_on_rails

---

React on Rails

React on Rails integrates React into Ruby on Rails applications with Rails view helpers, server-side rendering, hot reloading, and automatic bundle generation.

This README is intentionally brief. For setup guides, architecture, API reference, upgrades, examples, and Pro features, use the main documentation site: reactonrails.com/docs.

React on Rails is maintained by ShakaCode.

Start Here

1. Documentation home
2. Quick Start
3. Create a new app
4. Install into an existing Rails app
5. Examples
6. Compare OSS and Pro
7. Free & Pro and sign up
8. Compare with alternatives
9. Changelog

These docs are for React on Rails 17. Historical docs and code are available for v15 (code), v14, v13, v12, and v11. See the upgrade guide before using v15 material.

Install in 30 Seconds

Create a new React on Rails app:

npx create-react-on-rails-app my-app
cd my-app
bin/rails db:prepare
bin/dev

New apps default to React on Rails Pro for React 19.2 support. Use --standard only when you intentionally want an open-source-only setup.

Add React on Rails to an existing Rails app:

bundle add react_on_rails --strict
bundle exec rails generate react_on_rails:install
bin/dev

Render a component in any Rails view:

<%= react_component("HelloWorld", props: { name: "World" }) %>

If you hit setup issues, run:

bundle exec rake react_on_rails:doctor

Why Teams Use React on Rails

• Render React directly inside Rails views with react_component.
• Use Rails-oriented SSR in OSS, or upgrade to Pro for Node-rendered SSR, streaming SSR, and React Server Components.
• Keep a single Rails app instead of splitting into a separate frontend and API.
• Use modern bundling with Shakapacker, including Rspack support.

React on Rails Pro

React on Rails Pro adds higher-throughput SSR and advanced rendering features on top of the open-source gem, including Node renderer support, streaming SSR, React Server Components, fragment caching, and TanStack Router SSR.

React on Rails Pro is free in development, test, CI, and staging when used solely to prepare an application before production. Production use that serves real users or supports a live application requires ShakaStack Pro unless the organization qualifies for a free use. Organizations qualify when they meet all three limits across their affiliates: fewer than 10 people, under $1M revenue in the last twelve months, and under $1M in outside capital raised ever. Charities, educational institutions, and hospitals are free at any size.

ShakaStack Pro includes React on Rails Pro, ShakaPerf, and Inertia Rails SSR Cache for every affiliate, application, environment, repository, and developer in your organization, with Slack support and no limit on headcount or revenue. It costs $1,800 per year per organization at pro.reactonrails.com. An active React on Rails Pro subscription already counts as ShakaStack Pro. ShakaPerf follows its own free use rules, including for CI. No license key is needed to run React on Rails Pro; a key only marks your pages Licensed. See The ShakaStack License.

Start with the docs here:

1. React on Rails Pro docs
2. OSS vs Pro feature comparison
3. Upgrade to Pro
4. Free & Pro and sign up

This is the beginning of the README. Read the rest at the original. Read the full README ↗