React on Rails Documentation
For the best experience, visit our documentation website.
Browsing on GitHub? This guide will help you navigate the documentation.
📚 Learning Paths
Choose your journey based on your experience level:
🔰 Beginner Path
Perfect if you're 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 Developer Path
Jump straight to what you need
- Installation Guide - Add to existing Rails app
- API Reference - View helpers and JavaScript API
- Configuration - All configuration options
- Core Concepts - Architecture and SSR
🏗️ Migrating from Other Solutions
- From react-rails - Switch from the react-rails gem
- From Webpack to Rspack - Migrate to Rspack for faster builds
- Upgrading React on Rails - Version upgrade guide
🎯 Popular Use Cases
Find guidance for your specific scenario:
| 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 |
| Deploy to production | Deployment Guide |
| Troubleshoot issues | Troubleshooting |
📖 Documentation 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
- Migrating - From other frameworks
- Pro - React on Rails Pro features
🆘 Need Help?
- Troubleshooting Guide - Common issues and solutions
- GitHub Discussions - Ask questions
- React on Rails Pro - Advanced features and professional support
💡 Tip: For the best reading experience with full navigation and search, visit the documentation website.