bkd / react-webpack-rails-tutorial

Example of integration of Rails, react, redux, using the react_on_rails gem, webpack, enabling the es7 and jsx transpilers, and node integration. Live Demo:

Aloha from Justin Gordon (bio) and the ShakaCode Team! We're actively looking for new projects. If you like React on Rails, please consider contacting me at [e-mail] if we could potentially help you in any way. Besides consulting on bigger projects, ShakaCode is doing Skype plus Slack/Github based coaching for React on Rails. Click here for more information.

We're offering a free half-hour project consultation, on anything from React on Rails to any aspect of web application development for both consumer and enterprise products. In addition to React.js and Rails, we're doing react-native iOS and Android apps!

Whether you have a new project or need help on an existing project, feel free to contact me directly at [e-mail] and thanks in advance for any referrals!

Your support keeps this project going.

(Want to become a contributor? Contact us for an Slack team invite! Also, see "easy" issues and issues for the full tutorial.)

Videos

React On Rails Tutorial Series

1. History and Motivation
2. Basic Tutorial Walkthrough
3. Code Walkthrough

NEWS

This tutorial app demonstrates advanced functionality beyond what's provided by the React on Rails generators, mostly in the area of Webpack and React usage. Due to the architecture of placing all client side assets in the /client directory, React on Rails supports just about anything that Webpack and JavaScript can do, such as:

1. Handling of Sass and Bootstrap: This tutorial uses CSS modules via Webpack so that all your client side configuration can be handled in a pure JavaScript tooling manner. This allows for hot reloading and a better separation of concerns (Rails for server-side functionality versus NPM/Webpack for all things client side). The alternative approach of using the traditional Rails Asset Pipeline for your CSS is simpler and supported by React on Rails.
2. Hot Reloading with Rails: If you want to implement hot reloading after using React on Rails generators, then see Hot Reloading of Assets For Rails Development. The tutorial has different startup scripts than the generators. The dev mode has the WebapackDev server providing the JS and CSS assets to the tutorial. This means you get HOT RELOADING of your JS and CSS within your Rails app.

React, Redux, React-Bootstrap, ES7, Webpack, Rails Demo

Server Rendering via the react_on_rails gem

Live at www.reactrails.com

Check out our react-native client for this project!

This is a simple example application that illustrates the use of ReactJs to implement a commenting system. Front-end code leverages both ReactJs and Rails asset pipeline while the backend is 100% Rails. It shows off a little bit of the interactivity of a ReactJs application, allowing the commmenter to choose the form layout. react-bootstrap is used for the React components. A pure Rails UI generated from scaffolding is shown for comparison.

You can see this tutorial live here: http://reactrails.com/

Table of Contents

• Demoed Functionality
  • Technologies Involved
• Basic Demo Setup
  • Basic Command Line
  • Experimenting with Hot Reloading
• Javascript Development without Rails
• Rails Integration
• Webpack
  • Configuration Files
  • Additional Resources
• Sass, CSS Modules, and Twitter Bootstrap integration
  • Fonts with SASS
• Process Management during Development
• Rendering with Express Server
  • Setup
• Contributors
  • About ShakaCode
  • RubyMine and WebStorm
• Open Code of Conduct

Demoed Functionality

• Example of using the react_on_rails gem for easy react/webpack integration with Rails.
• Example of React with CSS Modules inside of Rails using Webpack as described in Smarter CSS builds with Webpack.
• Example of enabling hot reloading of both JS and CSS (modules) from your Rails app in development mode. Change your code. Save. Browser updates without a refresh!
• Example of Rails 5 with ReactJs/Redux/React-Router with Webpack and ES7.
• Enabling development of a JS client independently from Rails using the Webpack Dev Server. You can see this by starting the app and visiting http://localhost:4000
• Enabling the use of npm modules and Babel with a Rails application using Webpack.
• Easily enable retrofitting such a JS framework into an existing Rails app. You don't need a brand new single page app!
• Example setting up Ruby and JavaScript linting in a real project, with corresponding CI rake tasks.

Technologies involved

See package.json and Gemfile for versions

1. react_on_rails gem
2. React
3. react-bootstrap
4. bootstrap-loader
5. Redux
6. react-router
7. react-router-redux
8. Webpack with hot-reload (for local dev)
9. Babel transpiler
10. Ruby on Rails 5 for backend app and comparison with plain HTML
11. Heroku for Rails 5 deployment
12. Turbolinks 5

Basic Demo Setup

1. Be sure that you have Node installed! We suggest nvm, with node version v6.0 or above. See this article Updating and using nvm.
2. git clone [e-mail]:shakacode/react-webpack-rails-tutorial.git
3. cd react-webpack-rails-tutorial
4. Check that you have Ruby 2.3.0 or greater
5. Check that you're using the right version of node. Run nvm list to check. Use 5.5 or greater.
6. Check that you have Postgres installed. Run which postgres to check. Use 9.4 or greater.
7. Check that you have qmake installed. Run which qmake to check. If missing, follow these instructions: Installing Qt and compiling capybara-webkit
8. bundle install
9. npm install
10. rake db:setup
11. foreman start -f Procfile.hot
12. Open a browser tab to http://localhost:3000 for the Rails app example with HOT RELOADING
13. Try Hot Reloading steps below!
14. foreman start -f Procfile.static
15. Open a browser tab to http://localhost:3000 for the Rails app example.
16. When you make changes, you have to refresh the browser page.

Basic Command Line

1. Run all linters and tests: rake
2. See all npm commands: npm run
3. To start all development processes: foreman start -f Procfile.dev
4. To start only all Rails development processes: foreman start -f Procfile.hot

Experimenting with Hot Reloading: applies to both Procfile.hot and Procfile.express

1. With the browser open to any JSX file, such as client/app/bundles/comments/components/CommentBox/CommentBox.jsx and you can change the JSX code, hit save, and you will see the screen update without refreshing the window. This applies to port 3000 and port 4000.
2. Try changing a .scss file, such as a color in client/app/bundles/comments/components/CommentBox/CommentList/Comment/Comment.scss. You can see port 3000 or 4000 update automatically.
3. Be sure to take a look at the different Procfiles in this directory, as described below.

Javascript development without Rails: using the Webpack Dev Server

1. Run the node server with file server-express.js with command npm run or cd client && node server-express.js.
2. Point your browser to http://localhost:4000

Save a change to a JSX file and see it update immediately in the browser! Note, any browser state still exists, such as what you've typed in the comments box. That's totally different than Live Reload which refreshes the browser. Note, we just got this working with your regular Rails server! See above for Hot Loading.

Rails Integration

We're now using Webpack for all Sass and JavaScript assets so we can do CSS Modules within Rails!

• Production Deployment: We previously had created a file lib/tasks/assets.rake to modify the Rails precompile task to deploy assets for production. However, we add this automatically in newer versions of React on Rails. If you need to customize this file, see lib/tasks/assets.rake from React on Rails as an example as well as the doc file: heroku-deployment.md.

  • Configure Buildpacks

    heroku buildpacks:set heroku/ruby --app your-app
    heroku buildpacks:add --index 1 heroku/nodejs --app your-app
    heroku buildpacks:set --index 3 https://github.com/tempoautomation/heroku-buildpack-sourceversion.git --app your-app
    

• Development Mode: Two flavors: Hot reloading assets (JavaScript & CSS) and Static loading.

  • Hot Loading: We modify the URL in application.html.erb based on whether or not we're in production mode using the helpers env_stylesheet_link_tag and env_javascript_include_tag. Development mode uses the Webpack Dev server running on port 3500. Other modes (production/test) use precompiled files. See Procfile.hot. Procfile.dev also starts this mode. Note, you don't have to refresh a Rails web page to view changes to JavaScript or CSS.

  • Static Loading: This uses webpack to create physical files of the assets, both JavaScript and CSS. This is essentially what we had before we enabled Hot Loading. You have to refresh the page to see changes to JavaScript or CSS. See Procfile.static. It is important to note that tests will use the same statically generated files.

    • Note, the following view helpers do the magic to make this work:

  <%= env_stylesheet_link_tag(static: 'application_static', hot: 'application_non_webpack', options: { media: 'all', 'data-turbolinks-track' => true })  %>
  <%= env_javascript_include_tag(hot: ['http://localhost:3500/vendor-bundle.js', 'http://localhost:3500/app-bundle.js']) %>
  <%= env_javascript_include_tag(static: 'application_static', hot: 'application_non_webpack', options: { 'data-turbolinks-track' => true }) %>

• Testing Mode: When running tests, it is useful to run foreman start -f Procfile.spec in order to have webpack automatically recompile the static bundles. Rspec is configured to automatically check whether or not this process is running. If it is not, it will automatically rebuild the webpack bundle to ensure you are not running tests on stale client code. This is achieved via the ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config) line in the rails_helper.rb file. If you are using this project as an example and are not using RSpec, you may want to implement similar logic in your own project.

Webpack

Configuration Files

• webpack.client.base.config.js: Common client configuration file to minimize code duplication for webpack.client.rails.build.config, webpack.client.rails.hot.config, webpack.client.express.config
• webpack.client.express.config.js: Webpack configuration for Express server client/server-express.js
• webpack.client.rails.build.config.js: Client side js bundle for deployment and tests.
• webpack.client.rails.hot.config.js: Webpack Dev Server bundler for serving rails assets on port 3500, used by client/server-rails-hot.js, for hot reloading JS and CSS within Rails.
• webpack.server.rails.build.config.js: Server side js bundle, used by server rendering.

Additional Resources

• Webpack Docs
• Webpack Cookbook
• Good overview: Pete Hunt's Webpack Howto

Sass, CSS Modules, and Twitter Bootstrap Integration

We're using Webpack to handle Sass assets so that we can use CSS modules. The best way to understand how we're handling assets is to close follow this example. We'll be working on more docs soon. If you'd like to give us a hand, that's a great way to learn about this!

For example in client/app/bundles/comments/components/CommentBox/CommentBox.jsx, see how we use standard JavaScript import syntax to refer to class names that come from CSS modules:

import css from './CommentBox.scss';

export default class CommentBox extends React.Component {
  render() {
    const { actions, data } = this.props;
    const cssTransitionGroupClassNames = {
      enter: css.elementEnter,
      enterActive: css.elementEnterActive,
      leave: css.elementLeave,
      leaveActive: css.elementLeaveActive,
    };
  }
}

Fonts with SASS

The tutorial makes use of a custom font OpenSans-Light. We're doing this to show how to add assets for the CSS processing. The font files are located under client/app/assets/fonts and are loaded by both the Rails asset pipeline and the Webpack HMR server.

Process management during development

bundle exec foreman start -f <Procfile>

1. Procfile.dev: Starts the Webpack Dev Server and Rails with Hot Reloading.
2. Procfile.hot: Starts the Rails server and the webpack server to provide hot reloading of assets, JavaScript and CSS.
3. Procfile.static: Starts the Rails server and generates static assets that are used for tests.
4. Procfile.spec: Starts webpack to create the static files for tests. Good to know: If you want to start rails s separately to debug in pry, then run Procfile.spec to generate the assets and run rails s in a separate console.
5. Procfile.static.trace: Same as Procfile.static but prints tracing information useful for debugging server rendering.
6. Procfile.express: Starts only the Webpack Dev Server for rendering your components with only an Express server.

In general, you want to avoid running more webpack watch processes than you need.

Rendering with Express Server

UPDATE: 2016-07-31

We no longer recommend using an express server with Rails. It's simply not necessary because:

1. Rails can hot reload
2. There's extra maintenance in keeping this synchronized.
3. React on Rails does not have a shared_store JS rendering, per issue #504

Setup

1. foreman start -f Procfile.express
2. Open a browser tab to http://localhost:4000 for the Hot Module Replacement Example just using an express server (no Rails involved). This is good for fast prototyping of React components. However, this setup is not as useful now that we have hot reloading working for Rails!
3. Try Hot Reloading steps below!

Contributors

The Shaka Code team!, led by Justin Gordon, along with with many others. See contributors.md

RubyMine and WebStorm

Special thanks to JetBrains for their great tools: RubyMine and WebStorm. Some developers of this project use RubyMine at the top level, mostly for Ruby work, and we use WebStorm opened up to the client directory to focus on JSX and Sass files.

Open Code of Conduct

This project adheres to the Open Code of Conduct. By participating, you are expected to uphold this code.

About ShakaCode

If you would like to know more about ShakaCode, please read Who Is ShakaCode and Success the ShakaCode Way!

Please visit our forums!. We've got a category dedicated to react_on_rails.

If you're looking for consulting on a project using React and Rails, email us at [e-mail]! You can also join our slack room for some free advice. Email us for an invite.

We're looking for great developers that want to work with Rails + React (and react-native!) with a remote-first, distributed, worldwide team, for our own products, client work, and open source. More info here.