-
-
Notifications
You must be signed in to change notification settings - Fork 633
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
6 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,8 @@ | ||
| # React on Rails Basic Tutorial | ||
|
|
||
| * NOTE: Please be sure to use the BETA or RC versions of React on Rails until 9.0 is released.* | ||
|
|
||
|
|
||
| This tutorial setups up a new Rails app with **React on Rails**, demonstrating Rails + React + Redux + Server Rendering. It is updated to 9.0.0. | ||
|
|
||
| After finishing this tutorial you will get an application that can do the following (live on Heroku): | ||
|
|
@@ -55,8 +58,6 @@ bundle exec rails webpacker:install:react | |
| ``` | ||
|
|
||
|
|
||
|  | ||
|
|
||
|
|
||
| Add the **React On Rails** gem to your Gemfile: | ||
|
|
||
|
|
@@ -65,10 +66,9 @@ gem 'react_on_rails', '9.0.0' # use latest gem version, prefer exact ver | |
| ``` | ||
|
|
||
|
|
||
|  | ||
|
|
||
| Then run `bundle` and commit the git repository (or `rails generate` will not work properly) | ||
|
|
||
|
|
||
| ``` | ||
| bundle | ||
|
|
@@ -85,21 +85,15 @@ rails generate react_on_rails:install | |
| bundle && yarn | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| and then run server with | ||
|
|
||
| ``` | ||
| foreman start -f Procfile.dev | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| Visit http://localhost:3000/hello_world and see your **React On Rails** app running! | ||
| Note, foreman defaults to PORT 5000 unless you set the value of PORT in your environment or in the Procfile. | ||
|
|
||
|  | ||
|
|
||
| ### Custom IP & PORT setup (Cloud9 example) | ||
|
|
||
| In case you are running some custom setup with different IP or PORT you should also edit Procfile.dev. For example to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080. The default generated file `Procfile.dev` uses `-p 3000`. | ||
|
|
@@ -115,8 +109,8 @@ Then visit https://your-shared-addr.c9users.io:8080/hello_world | |
|
|
||
| It's super important to exclude certain directories from RubyMine or else it will slow to a crawl as it tries to parse all the npm files. | ||
|
|
||
| * `public/webpack` (or `app/assets/webpack` on older versions of react_on_rails) | ||
| * `client/node_modules` | ||
| * Generated files, per the settings in your `config/webpacker.yml`, which default to `public/packs` and `public/packs-test` | ||
| * `node_modules` | ||
|
|
||
| ## Deploying to Heroku | ||
|
|
||
|
|
@@ -225,13 +219,4 @@ git commit -m "Latest changes" | |
| git push heroku master | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ## Links | ||
| These are updated for 8.0.0: | ||
|
|
||
| * [PR for using the generator with the Redux option](https://github.com/shakacode/react_on_rails-test-new-redux-generation/pull/17) | ||
| * [PR showing the changes to deploy to Heroku](https://github.com/shakacode/react_on_rails-test-new-redux-generation/pull/18) | ||
| * [Live on Heroku](https://hello-react-on-rails-8-0-0.herokuapp.com/) | ||
|
|
||
| Feedback is greatly appreciated! As are stars on github! If you want personalized help, don't hesitate to get in touch with us at [[email protected]](mailto:[email protected]). | ||