React on Rails Documentation
For the best experience, visit our documentation website.
Browsing on GitHub? This guide will help you navigate the documentation.
Open Source (OSS)
The core React on Rails gem and npm package.
Learning Paths
New to React on Rails?
- Introduction - What is React on Rails and why use it?
- Quick Start - Get your first component running in 15 minutes
- Tutorial - Build a complete app with Redux and routing
Experienced developers:
- Installation Guide - Add to existing Rails app
- API Reference - View helpers and JavaScript API
- Configuration - All configuration options
- Core Concepts - Architecture and SSR
Categories
- Getting Started - Installation, quick start, tutorial
- Core Concepts - How React on Rails works, SSR, auto-bundling
- Building Features - Redux, routing, i18n, testing
- Configuration - All configuration options
- API Reference - View helpers and JavaScript API
- Deployment - Production deployment and troubleshooting
- Upgrading - Version upgrade guides
- Changelog - All notable changes by version
- Migrating - From other frameworks
- Misc - Articles, tips, credits, and other resources
Quick Reference
| I want to... | Go here |
|---|---|
| Add React to existing Rails app | Installation Guide |
| Enable server-side rendering | SSR Guide |
| Set up hot reloading | HMR Setup |
| Use Redux with Rails | Redux Integration |
| Use TanStack Router | TanStack Router Guide |
| Migrate to React Server Components | RSC Migration Guide |
| Deploy to production | Deployment Guide |
| Manage page metadata (title, meta) | React 19 Native Metadata |
| Troubleshoot issues | Troubleshooting |
| Compare OSS vs Pro features | OSS vs Pro |
| Compare with alternatives | Comparison with Alternatives |
Pro
Performance enhancements, React Server Components, and advanced features. Requires a React on Rails Pro subscription (free or very low cost for startups and small companies).
- Upgrading to Pro - Switch from OSS to Pro in three steps
- Installation - Set up React on Rails Pro
- Configuration - Pro-specific settings
- React Server Components - RSC with Rails
- Streaming SSR - Progressive server rendering
- SSR Caching - Prerender and fragment caching
- Bundle Caching - Avoid redundant webpack builds
- Node Renderer - Dedicated Node.js rendering server
- Code Splitting - Loadable components
- Ruby API (Pro) - Pro view helpers and utilities
- Upgrading Pro - Version upgrade guide
- Troubleshooting - Common Pro issues
Need Help?
- Troubleshooting Guide - Common issues and solutions
- GitHub Discussions - Ask questions
- React on Rails Pro - Advanced features and professional support