Skip to content

Integration of React + Webpack + Rails including server-side rendering of React, enabling a better developer experience and faster client performance.

License

Notifications You must be signed in to change notification settings

shakacode/react_on_rails

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

reactrails


LicenseGem Version npm version Coverage Status

Build Main Build JS Tests Build Rspec Tests Linting

โšก What's New

๐Ÿš€ React on Rails v16.0 Released! Major modernization with ESM support, enhanced React Server Components, and streamlined configuration.

  • ESM-only package: Modern module system with better tree-shaking and performance
  • React Server Components: Improved rendering flow and new RSCRoute component for seamless SSR
  • Performance improvements: New async loading strategies and optimized bundle generation
  • Webpacker removal: Streamlined for Shakapacker-only support (>= 6.0)
  • React on Rails Pro supports the latest features of React 18, including React Server Components and streaming. Contact Justin Gordon for more information.
  • ShakaCode now maintains the official successor to rails/webpacker, shakapacker.

These are the docs for React on Rails 16. To see the older docs and code: v14, v13, v12, and v11.

๐ŸŽฏ About React on Rails

Seamlessly integrate React components into your Rails application with server-side rendering, hot reloading, and automatic bundle optimization.

"The easiest way to add React to Rails" - Thousands of developers rely on React on Rails for production applications.

This project is maintained by ShakaCode with โค๏ธ from the Rails and React communities.

ShakaCode Upgrade Support

ShakaCode focuses on helping Ruby on Rails teams better use React and Webpack. We can upgrade your project and improve your development and customer experiences, allowing you to focus on building new features or fixing bugs instead.

For an overview of working with us, see our Client Engagement Model article and how we bill for time.

We also specialize in helping development teams lower infrastructure and CI costs. Check out our project Control Plane Flow, which can allow you to get the ease of Heroku with the power of Kubernetes and big cost savings.

If you think ShakaCode can help your project, click here to book a call with Justin Gordon, the creator of React on Rails.

Upgrading React on Rails

After upgrading to a new major version, run the generator to get latest defaults:

rails generate react_on_rails:install

Important: Review changes carefully before applying to avoid overwriting custom configurations. The generator updates:

  • bin/dev (improved development workflow)
  • webpack configurations
  • shakapacker.yml settings
  • other configuration files

Troubleshooting Setup Issues

If you encounter issues during installation or after upgrading, use the doctor command to diagnose your setup:

rake react_on_rails:doctor

The doctor command checks your environment, dependencies, and configuration files to identify potential issues. Use VERBOSE=true rake react_on_rails:doctor for detailed output.

For detailed upgrade instructions, see upgrade guide documentation.

React on Rails Pro

Some features of React on Rails regarding performance require a React on Rails Pro subscription.

Note: the subscription price is free for evaluation and non-production use.

Notable new features include:

  • React Server Components
  • Streaming SSR
  • Loadable Components
  • Code Splitting with React Router

React on Rails Pro is the best way to optimize your Webpack setup for React on Rails, including code splitting with React Router and loadable-components with server-side rendering for SEO and hot-reloading for developers.

We did this for Popmenu, lowering Heroku costs 20-25% while getting a 73% decrease in average response times. Several years later, Popmenu serves tens of millions of SSR requests daily with React on Rails Pro.

If you're interested, read more about React on Rails Pro and book a call.

๐Ÿ“š Quick Start

New to React on Rails? Get up and running in minutes:

๐Ÿš€ 15-Minute Quick Start - Your first React component ๐Ÿ“– Complete Documentation - Comprehensive guides and API reference ๐ŸŽฎ Live Demo - See it in action with source code

Project Objective

To provide a high-performance framework for integrating Ruby on Rails with React, especially regarding React Server-Side Rendering for better SEO and improved performance.

โœจ Why React on Rails?

Feature Benefit
๐ŸŽฏ Smart Bundle Loading Automated bundle optimization based on components used - no more manual javascript_pack_tags configuration
โšก Server-Side Rendering Enhanced React Server Components support for better SEO and UX performance
๐Ÿš€ Advanced Loading sync, async, and defer options for optimal performance based on your needs
๐Ÿ”ฅ Hot Module Replacement Instant feedback during development with tight Shakapacker integration
๐Ÿ“ฆ Easy Props Passing Direct Rails โ†’ React data flow without separate API calls
๐Ÿ—บ๏ธ Router Integration React Router with SSR support
๐Ÿช State Management Redux integration with server-side rendering
๐ŸŒ Internationalization I18n and localization support for global apps
๐ŸŽจ Modern React React 18+ with enhanced React Server Components and latest patterns
๐Ÿฆ„ ReScript Support ReScript integration for type-safe development

Trusted by thousands - See real production sites using React on Rails

See Rails/Shakapacker React Integration Options for comparisons to other gems.

Online demo

ShakaCode Forum Premium Content

Requires creating a free account.

Prerequisites

  • Ruby on Rails >= 5
  • Shakapacker >= 6.0 (Webpacker is no longer supported as of v16)
  • Ruby >= 3.2 (CI tested: 3.2 - 3.4)
  • Node.js >= 20 (CI tested: 20 - 22)
  • A JavaScript package manager (npm, yarn, pnpm, or bun)

๐Ÿ†˜ Get Help & Support

Need immediate help? Here are your options, ordered by response time:

Additional Resources:

Contributing

Bug reports and pull requests are welcome. To get started, see Contributing and the list of help wanted issues.

Work with Us

ShakaCode is hiring passionate software engineers to work on our projects, including HiChee!

License

The gem is available as open source under the terms of the MIT License.

Note, some features are available only with a React on Rails Pro subscription. See React on Rails Pro for more information.

Supporters

The following companies support our open-source projects, and ShakaCode uses their products!



JetBrains ScoutAPM Control Plane
BrowserStack Rails Autoscale Honeybadger Reviewable