Documentation Guide

Current docs: This documentation is for React on Rails 17. For historical v15 material, see the React on Rails 15.0.0 docs and React on Rails 15.0.0 code. Version 15.0.0 was retracted, so use these links only when maintaining older applications.

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

• Create a new app
• Quick Start
• Tutorial — build a complete app

Adding React to an existing Rails app

• Install into an existing Rails app
• Render your first component

Already using React on Rails OSS?

• Compare OSS and Pro
• Upgrade to Pro

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
• 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

Friendly License Model

• Try React on Rails Pro freely in development, test, CI/CD, and staging. No token is required to evaluate.
• Production deployments require a paid license. See Pro pricing and sign up for current options. If your organization is budget-constrained, contact us about free or low-cost licenses.

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.

Need more help?

• Historical Reference
• GitHub Discussions