Skip to content

Commit 0b17705

Browse files
authored
Update README.md
1 parent d204668 commit 0b17705

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ My article "[Why Hire ShakaCode?](https://blog.shakacode.com/can-shakacode-help-
2424

2525
If any of this resonates with you, please email me, [[email protected]](mailto:[email protected]). I offer a free half-hour project consultation, on anything from React on Rails to any aspect of web or mobile application development for both consumer and enterprise products.
2626

27-
We are **[currently looking to hire](http://www.shakacode.com/about/#work-with-us)** like-minded developers that wish to work on our projects, including [Friends and Guests](https://www.friendsandguests.com).
27+
We are **[currently looking to hire](http://www.shakacode.com/about/#work-with-us)** like-minded developers that wish to work on our projects, including [Hawaii Chee](https://www.hawaiichee.com).
2828

2929
I appreciate your attention and sharing of these offerings with anybody that we can help. Your support allows me to bring you and your team [front-end happiness in the Rails world](https://www.youtube.com/watch?v=SGkTvKRPYrk).
3030

@@ -40,7 +40,7 @@ Please [**click to subscribe**](https://app.mailerlite.com/webforms/landing/l1d9
4040
* **Slack Room**: [Contact us](mailto:[email protected]) for an invite to the ShakaCode Slack room! Let us know if you want to contribute.
4141
* **[forum.shakacode.com](https://forum.shakacode.com)**: Post your questions
4242
* **[@ShakaCode on Twitter](https://twitter.com/shakacode)**
43-
* For a live, [open source](https://github.com/shakacode/react-webpack-rails-tutorial), example of this gem, see [www.reactrails.com](http://www.reactrails.com).
43+
* For a live, example of the code in this repo, see [www.reactrails.com](http://www.reactrails.com).
4444

4545
------
4646

@@ -49,7 +49,7 @@ From Joel Hooks, Co-Founder, Chief Nerd at [egghead.io](https://egghead.io/), Ja
4949

5050
![2017-01-30_11-33-59](https://cloud.githubusercontent.com/assets/1118459/22443635/b3549fb4-e6e3-11e6-8ea2-6f589dc93ed3.png)
5151

52-
For more testimonials, see [Live Projects](PROJECTS.md) and [Kudos](./KUDOS.md).
52+
For more testimonials, see [Live Projects](https://github.com/shakacode/react_on_rails/blob/master/PROJECTS.md) and [Kudos](https://github.com/shakacode/react_on_rails/blob/master/KUDOS.md).
5353

5454
-------
5555

@@ -73,7 +73,7 @@ Justin is currently working with a couple contributors on some new private examp
7373

7474
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:
7575

76-
1. **Handling of Sass and Bootstrap**: This tutorial uses [CSS modules via Webpack](https://github.com/css-modules/css-modules) 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](https://github.com/shakacode/react_on_rails). _If you are looking for more information about using assets in your client JavaScript, check out the React on Rails docs: [Rails Assets](https://github.com/shakacode/react_on_rails/blob/master/docs/additional-reading/rails-assets.md) and [Webpack, the Asset Pipeline, and Using Assets w/ React](https://github.com/shakacode/react_on_rails/blob/master/docs/additional-reading/rails-assets-relative-paths.md). For real examples, look at the Webpack config files in the [client/](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/client) directory of this project, as well as some of the components that are using the client side assets (ex. [CommentScreen component](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/app/bundles/comments/components/CommentScreen/CommentScreen.jsx))._
76+
1. **Handling of Sass and Bootstrap**: This tutorial uses [CSS modules via Webpack](https://github.com/css-modules/css-modules) 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](https://github.com/shakacode/react_on_rails). _If you are looking for more information about using assets in your client JavaScript, check out the React on Rails docs: [Asset Pipeline](https://github.com/shakacode/react_on_rails/blob/master/docs/additional-reading/asset-pipeline.md) and [Webpack, the Asset Pipeline, and Using Assets w/ React](https://github.com/shakacode/react_on_rails/blob/master/docs/additional-reading/rails-assets-relative-paths.md). For real examples, look at the Webpack config files in the [client/](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/client) directory of this project, as well as some of the components that are using the client side assets (ex. [CommentScreen component](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/app/bundles/comments/components/CommentScreen/CommentScreen.jsx))._
7777
1. **Hot Reloading with Rails**: _NOTE: This needs updating. Want to help?_ If you want to implement hot reloading after using React on Rails generators, then see [Hot Reloading of Assets For Rails Development](https://github.com/shakacode/react_on_rails/blob/master/docs/additional-reading/hot-reloading-rails-development-asset-pipeline.md). 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.
7878

7979
# React, Redux, React-Bootstrap, ES7, Webpack, Rails Demo
@@ -114,7 +114,7 @@ You can see this tutorial live here: [http://reactrails.com/](http://reactrails.
114114
- 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!
115115
- Example of React/Redux with Rails Action Cable.
116116
- Example of Rails 5 with ReactJs/Redux/React-Router with Webpack and ES7.
117-
- Enabling development of a JS client independently from Rails using the [Webpack Dev Server](https://webpack.github.io/docs/webpack-dev-server.html). You can see this by starting the app and visiting http://localhost:4000
117+
- Enabling development of a JS client independently from Rails using the [Webpack Dev Server](https://webpack.js.org/configuration/dev-server/). You can see this by starting the app and visiting http://localhost:4000
118118
- Enabling the use of npm modules and [Babel](https://babeljs.io/) with a Rails application using [Webpack](https://webpack.github.io/).
119119
- Easily enable retrofitting such a JS framework into an existing Rails app. You don't need a brand new single page app!
120120
- Example setting up Ruby and JavaScript linting in a real project, with corresponding CI rake tasks.
@@ -145,8 +145,7 @@ See package.json and Gemfile for versions
145145
1. Check that you're using the right version of node. Run `nvm list` to check. Use 5.5 or greater.
146146
1. Check that you have Postgres installed. Run `which postgres` to check. Use 9.4 or greater.
147147
1. Check that you have `qmake` installed. Run `which qmake` to check. If missing, follow these instructions: [Installing Qt and compiling capybara-webkit](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit)
148-
1. Check that you have Redis installed. Run `which redis-server` to check. If missing, install with Homebrew (`brew install redis`) or follow [these instructions](https://redis.io/topics/quickstart#installing-redis
149-
).
148+
1. Check that you have Redis installed. Run `which redis-server` to check. If missing and on MacOS, install with Homebrew (`brew install redis`)
150149
1. `bundle install`
151150
1. `brew install yarn`
152151
1. `yarn`
@@ -219,7 +218,7 @@ line in the `rails_helper.rb` file. If you are using this project as an example
219218
- `webpack.server.rails.build.config.js`: Server side js bundle, used by server rendering.
220219

221220
### Additional Resources
222-
- [Webpack Docs](http://webpack.github.io/docs/)
221+
- [Webpack Docs](https://webpack.js.org/)
223222
- [Webpack Cookbook](https://christianalfoni.github.io/react-webpack-cookbook/)
224223
- Good overview: [Pete Hunt's Webpack Howto](https://github.com/petehunt/webpack-howto)
225224

@@ -282,9 +281,6 @@ We no longer recommend using an express server with Rails. It's simply not neces
282281
### RubyMine and WebStorm
283282
Special thanks to [JetBrains](https://www.jetbrains.com) for their great tools: [RubyMine](https://www.jetbrains.com/ruby/) and [WebStorm](https://www.jetbrains.com/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.
284283

285-
## Open Code of Conduct
286-
This project adheres to the [Open Code of Conduct](http://todogroup.org/opencodeofconduct/#fetch/[email protected]). By participating, you are expected to uphold this code.
287-
288284
## About [ShakaCode](http://www.shakacode.com/)
289285
If you would like to know more about ShakaCode, please read [Who Is ShakaCode](http://www.shakacode.com/2015/09/17/who-is-shaka-code.html) and [Success the ShakaCode Way!](http://www.shakacode.com/2015/11/26/success-the-shakacode-way.html)
290286

0 commit comments

Comments
 (0)