This gem provides easy and convenient way to build modern JavaScript stack on top of Rails applications using Webpack and React.
See 0.6-stable for latest release.
- Install Generator for quick Webpack setup.
- Integrated react-hot-loader
- ES6/7 support with babeljs.
- Node.js based server-side JavaScript execution.
- React integration with server prerender option.
- React-router integration.
- rwr-alt plugin that makes it possible to populate and share Alt stores between react component located in different parts of rails views.
- rwr-redux allows to use redux state containers in a rails views.
- rwr-react_router react-router integration.
- rwr-view_helpers handy view helpers.
Add this line to your application's Gemfile:
gem 'react_webpack_rails'Execute:
$ bundle
Then run installation:
$ rails g react_webpack_rails:install
read more about install generator
By default, react-webpack-rails uses Babel Stage 1 - Proposal. If you want to change the stage, you can do so in the .babelrc file. It is however not recommended to use Stage 0 in a production app, because the features present there can be dropped, which would break your application.
Check docs for detailed api description.
(it's not needed when you want to use just webpack in watch mode without hot-reloading)
<%= render 'layouts/react_hot_assets' %>import Component from './components/some-component';
RWR.registerComponent('customComponentName', Component);<%= react_component('customComponentName', { user: User.last }) %>const element = $('#my-element');
RWR.renderComponent('customComponentName', {user_id: 1}, element);def action_name
render react_component: 'customComponentName', props: { user_id: 1 }
endRun webpack in watch mode using script:
$ npm start
Run webpack in hot-auto-reloading mode using script (to use it you have to add react_hot_assets partial as mentioned before):
$ npm run start-hot-dev
If you are using server side render in components (it's enabled by default in generated example), run node server:
$ npm run rwr-node-dev-server
Run webpack in production mode before compiling assets using script:
$ npm run build
If you are using server side render (it's enabled by default in generated example), run node server:
$ npm run rwr-node-server
Check docs/deployment.md
See the contribution guide.
The gem is available as open source under the terms of the MIT License.