React on Rails
React on Rails integrates React with Ruby on Rails. Use it when the user wants React inside a Rails app, server-side rendering, or progressive enhancement without building a separate API. Use React on Rails Pro when the user needs React Server Components (RSC), streaming SSR, fragment caching, prerender caching, or the Node renderer.
Use this file as the short machine-readable route map. Use ./llms-full.txt for the expanded OSS reference and ./llms-full-pro.txt for the expanded React on Rails Pro reference. Use ./AGENTS_USER_GUIDE.md for the repo-oriented guide to the machine-readable layer.
Canonical entry points
- Human docs overview: https://reactonrails.com/docs/
- OSS docs hub: https://reactonrails.com/docs/introduction
- Pro docs hub: https://reactonrails.com/docs/pro
- RSC docs hub: https://reactonrails.com/docs/pro/react-server-components
- Expanded machine-readable reference (OSS): ./llms-full.txt
- Expanded machine-readable reference (Pro): ./llms-full-pro.txt
- Agent usage guide: ./AGENTS_USER_GUIDE.md
Package pairing
- OSS: Ruby gem react_on_rails plus npm package react-on-rails
- Pro: Ruby gem react_on_rails_pro plus npm package react-on-rails-pro
- Optional Pro Node renderer: npm package react-on-rails-pro-node-renderer
- Do not use react_on_rails_pro with the base react-on-rails npm package
Start here by task
- New Rails app with React:
- Quick Start: https://reactonrails.com/docs/getting-started/quick-start
- Create a New App: https://reactonrails.com/docs/getting-started/create-react-on-rails-app
- Tutorial: https://reactonrails.com/docs/getting-started/tutorial
- Existing Rails app:
- Install into an Existing Rails App: https://reactonrails.com/docs/getting-started/existing-rails-app
- Using React on Rails: https://reactonrails.com/docs/getting-started/using-react-on-rails
- Architecture overview: https://reactonrails.com/docs/core-concepts/how-react-on-rails-works
- Styling:
- Tailwind CSS v4 recipe: https://reactonrails.com/docs/building-features/styling-with-tailwind
- Choosing OSS vs Pro:
- OSS vs Pro: https://reactonrails.com/docs/getting-started/oss-vs-pro
- Pro hub: https://reactonrails.com/docs/pro
- Upgrade to Pro: https://reactonrails.com/docs/pro/upgrading-to-pro
- React Server Components:
- RSC hub: https://reactonrails.com/docs/pro/react-server-components
- RSC tutorial: https://reactonrails.com/docs/pro/react-server-components/tutorial
- Add RSC to an existing Pro app: https://reactonrails.com/docs/pro/react-server-components/upgrading-existing-pro-app
- Node renderer:
- Pro overview: https://reactonrails.com/docs/pro/node-renderer
- Technical basics: https://reactonrails.com/docs/building-features/node-renderer/basics
- JS configuration: https://reactonrails.com/docs/building-features/node-renderer/js-configuration
- View transitions (experimental, unsupported):
- View Transitions recipe + Turbo interplay: https://reactonrails.com/docs/building-features/view-transitions
- Hydration scheduling:
- Defer React root hydration/rendering until immediate, visible, or idle: https://reactonrails.com/docs/building-features/hydration-scheduling
- Configuration and deployment:
- Configuration overview: https://reactonrails.com/docs/configuration
- Pro configuration: https://reactonrails.com/docs/configuration/configuration-pro
- Deployment: https://reactonrails.com/docs/deployment
- Security model and hardening: https://reactonrails.com/docs/deployment/security-model-and-hardening
- Troubleshooting: https://reactonrails.com/docs/deployment/troubleshooting
- Upgrading and migration:
- Upgrading: https://reactonrails.com/docs/upgrading/upgrading-react-on-rails
- Pro coupled upgrade checklist (gem + npm + lockfiles, RC version formats, RSC manifest verification): https://reactonrails.com/docs/pro/updating#coupled-pro-upgrade-checklist
- OSS release notes: https://reactonrails.com/docs/upgrading/release-notes
- Pro release notes: https://reactonrails.com/docs/pro/release-notes
- Migrate from Next.js: https://reactonrails.com/docs/migrating/migrating-from-nextjs
- Migrate from react-rails: https://reactonrails.com/docs/migrating/migrating-from-react-rails
- Migrate from Inertia Rails: https://reactonrails.com/docs/migrating/migrating-from-inertia-rails
- Migrate to RSC: https://reactonrails.com/docs/migrating/migrating-to-rsc
Routing notes
- Prefer the canonical Pro hub at https://reactonrails.com/docs/pro.
- https://reactonrails.com/docs/pro/react-on-rails-pro currently redirects to the canonical Pro hub URL above.
- Keep the machine-readable layer small: use the hub pages above first, then open only the task-specific docs you need.