Documentation Guide
React on Rails is one product with two tiers: open source for Rails + React integration, and Pro when you need higher SSR throughput, deeper RSC support, or maintainer-backed help.
Choose the path that matches your app
Starting a new Rails + React app
Adding React to an existing Rails app
Already using React on Rails OSS?
Evaluating Rails + React options
- Examples and migration references — maintained starters, migration repos, and Pro + RSC demos
- Example migrations — curated migration references and proof criteria
- Examples gallery — reactonrails.com showcase apps
- Compare with alternatives — decision guide covering Hotwire, Inertia, Next.js, and more
- Migrate from react-rails
Dive deeper when you need it
- Introduction
- Core Concepts
- Accessibility (a11y) — framework-specific a11y for SSR, hydration, and RSC-streamed UI
- API Reference
- Deployment and troubleshooting
- Configuration
- Changelog
Pro features
Start at React on Rails Pro for the canonical Pro route map, then choose the feature family you need:
- React Server Components - RSC overview and public demo evidence
- Streaming SSR - Progressive server rendering
- Node Renderer - Dedicated Node.js rendering server
- Pro Review App Security - Safe review-app defaults for public repositories
- Fragment Caching - Cache rendered components
- Upgrading to Pro - Switch from OSS to Pro in three steps
- Node Renderer: Container Deployment (Pro) - Sidecar vs. separate workloads, memory tuning, troubleshooting
ShakaCode Trust-Based Commercial Licensing
- React on Rails Pro and Inertia Rails SSR Cache are free in development, test, CI, and staging for everyone. Above the free line, what needs a subscription is production: anything that serves real users or supports a live application.
- ShakaPerf follows its own rule in every environment, because it runs in your development process. Above the free line, ongoing ShakaPerf work, including CI, needs ShakaStack Pro after a 45-day evaluation. Qualifying public open-source work stays free, and publishing a result does not make private work free.
- React on Rails Pro is free in production when the whole organization, counting affiliates, has fewer than 10 people, under $1M revenue in the last twelve months, and under $1M raised, ever. Charities, educational institutions, and hospitals are free at any size.
- ShakaStack Pro covers React on Rails Pro, ShakaPerf, and Inertia Rails SSR Cache for your whole organization, with Slack support, at $1,800 per year per organization. No limit on headcount or revenue. Subscribe. Already subscribed to React on Rails Pro? Your subscription counts as ShakaStack Pro. ShakaPerf and Inertia Rails SSR Cache are included for your whole organization, so there is nothing to buy. See Free & Pro.
- No license key is required to run Pro; a missing key only changes one HTML comment. Full terms: The React on Rails Pro License.
Packages
React on Rails ships as a Ruby gem with companion npm packages. Versions are pulled live from each registry.
| Package | Version | Registry | Description |
|---|---|---|---|
react_on_rails | RubyGems | Rails integration gem for React on Rails open source. | |
react-on-rails | npm | JavaScript runtime and helpers for the open source gem. | |
react_on_rails_pro | RubyGems | Pro Rails gem for SSR, RSC, streaming, and Node Renderer integration. | |
react-on-rails-pro | npm | Pro client package for higher-throughput SSR and related integrations. | |
react-on-rails-pro-node-renderer | npm | Dedicated Node.js renderer used by React on Rails Pro. | |
react-on-rails-rsc | npm | React Server Components support package. | |
create-react-on-rails-app | npm | CLI for scaffolding a new Rails and React app. |