Skip to content

Commit e7d93d8

Browse files
committed
Update README.md
1 parent 5b87871 commit e7d93d8

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ In no particular order:
5252
See package.json and Gemfile for versions
5353

5454
1. [react_on_rails gem](https://github.com/shakacode/react_on_rails/)
55-
1. [React](http://facebook.github.io/react/) (for front-end app)
55+
1. [React](http://facebook.github.io/react/)
5656
1. [react-bootstrap](https://react-bootstrap.github.io/)
5757
1. [bootstrap-loader](https://www.npmjs.com/package/bootstrap-loader/)
5858
1. [Redux](https://github.com/reactjs/redux)
@@ -68,9 +68,9 @@ See package.json and Gemfile for versions
6868
1. Be sure that you have Node installed! We suggest [nvm](https://github.com/creationix/nvm), with node version `v5.0` or above. See this article [Updating and using nvm](http://forum.shakacode.com/t/updating-and-using-nvm/293).
6969
1. `git clone [email protected]:shakacode/react-webpack-rails-tutorial.git`
7070
1. `cd react-webpack-rails-tutorial`
71-
1. Check that you have Ruby 2.2.4
72-
1. Check that you're using the right version of node. Run `nvm list` to check.
73-
1. Check that you have Postgres installed. Run `which postgres` to check.
71+
1. Check that you have Ruby 2.2.4 or greater
72+
1. Check that you're using the right version of node. Run `nvm list` to check. Use 5.5 or greater.
73+
1. Check that you have Postgres installed. Run `which postgres` to check. Use 9.4 or greater.
7474
1. `bundle install`
7575
1. `npm install`
7676
1. `rake db:setup`
@@ -79,6 +79,7 @@ See package.json and Gemfile for versions
7979
1. Open a browser tab to http://localhost:4000 for the Hot Module Replacement Example.
8080
1. With the browser open to any JSX file, such as [client/app/bundles/comments/components/CommentBox/CommentBox.jsx](client/app/bundles/comments/components/CommentBox/CommentBox.jsx) and you can change the JSX code, hit save, and you will see the sceen update without refreshing the window. This applies to port 3000 and port 4000.
8181
1. Try changing a `.scss` file, such as a color in [client/app/bundles/comments/components/CommentBox/CommentList/Comment/Comment.scss](client/app/bundles/comments/components/CommentBox/CommentList/Comment/Comment.scss). You can see port 3000 or 4000 update automatically.
82+
1. Be sure to take a look at the different Procfiles in this directory, as described below.
8283

8384
# KEY COMMANDS
8485
1. Run all linters and tests: `rake ci`
@@ -158,13 +159,14 @@ The tutorial makes use of a custom font OpenSans-Light. We're doing this to show
158159
bundle exec foreman start -f <Procfile>
159160
```
160161

161-
1. `Procfile.dev`: Starts the Webpack Dev Server and Rails with Hot Reloading.
162-
2. `Procfile.hot`: Starts the Rails server and the webpack server to provide hot reloading of assets, JavaScript and CSS.
163-
3. `Procfile.static`: Starts the Rails server and generates static assets that are used for tests.
164-
4. `Procfile.express`: Starts only the Webpack Dev Server.
165-
5. `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.
166-
6. `Procfile.static.trace`: Same as `Procfile.static` but prints tracing information useful for debugging server rendering.
167-
162+
1. [`Procfile.dev`](Procfile.dev): Starts the Webpack Dev Server and Rails with Hot Reloading.
163+
2. [`Procfile.hot`](Procfile.hot): Starts the Rails server and the webpack server to provide hot reloading of assets, JavaScript and CSS.
164+
3. [`Procfile.static`](Procfile.static): Starts the Rails server and generates static assets that are used for tests.
165+
4. [`Procfile.express`(Procfile.express): Starts only the Webpack Dev Server.
166+
5. [`Procfile.spec`](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.
167+
6. [`Procfile.static.trace`][Procfile.static.trace]: Same as `Procfile.static` but prints tracing information useful for debugging server rendering.
168+
169+
In genereral, you want to avoid running more webpack watch processes than you need. The `Procfile.dev`, for example, runs both the express server (Webpack dev server) and the Rails hot assets reloading server.
168170

169171
## Contributors
170172
[The Shaka Code team!](http://www.shakacode.com/about/) and many others!

0 commit comments

Comments
 (0)