{"action":"created","comment":{"url":"https://api.github.com/repos/shakacode/react_on_rails/pulls/comments/47457891","id":47457891,"diff_hunk":"@@ -0,0 +1,125 @@\n+Description:\n+\n+The react_on_rails:install generator combined with the example pull requests of\n+generator runs will get you up and running efficiently. There's a fair bit of\n+setup with integrating Webpack with Rails. Defaults for options are such that\n+the default is for the flag to be off. For example, the default for -R is that\n+redux is off, and the default of -b means that skip-bootstrap is off.\n+\n+* Redux\n+\n+    If you have used the --redux generator option, you will notice the familiar\n+    additional redux folders. The Hello World example has also been modified to\n+    use Redux.\n+\n+    Note the organizational paradigm of \"bundles\". These are like application","path":"lib/generators/USAGE","position":15,"original_position":15,"commit_id":"e99a3c4adfadc7dbee37e7123c08a5fe32b19b06","original_commit_id":"e99a3c4adfadc7dbee37e7123c08a5fe32b19b06","user":{"login":"robwise","id":6173488,"avatar_url":"https://avatars.githubusercontent.com/u/6173488?v=3","gravatar_id":"","url":"https://api.github.com/users/robwise","html_url":"https://github.com/robwise","followers_url":"https://api.github.com/users/robwise/followers","following_url":"https://api.github.com/users/robwise/following{/other_user}","gists_url":"https://api.github.com/users/robwise/gists{/gist_id}","starred_url":"https://api.github.com/users/robwise/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/robwise/subscriptions","organizations_url":"https://api.github.com/users/robwise/orgs","repos_url":"https://api.github.com/users/robwise/repos","events_url":"https://api.github.com/users/robwise/events{/privacy}","received_events_url":"https://api.github.com/users/robwise/received_events","type":"User","site_admin":false},"body":"We should start this line off by saying \"The generator uses ~Note~ the organizational\"","created_at":"2015-12-14T02:53:17Z","updated_at":"2015-12-14T02:53:17Z","html_url":"https://github.com/shakacode/react_on_rails/pull/161#discussion_r47457891","pull_request_url":"https://api.github.com/repos/shakacode/react_on_rails/pulls/161","_links":{"self":{"href":"https://api.github.com/repos/shakacode/react_on_rails/pulls/comments/47457891"},"html":{"href":"https://github.com/shakacode/react_on_rails/pull/161#discussion_r47457891"},"pull_request":{"href":"https://api.github.com/repos/shakacode/react_on_rails/pulls/161"}}},"pull_request":{"url":"https://api.github.com/repos/shakacode/react_on_rails/pulls/161","id":53495081,"html_url":"https://github.com/shakacode/react_on_rails/pull/161","diff_url":"https://github.com/shakacode/react_on_rails/pull/161.diff","patch_url":"https://github.com/shakacode/react_on_rails/pull/161.patch","issue_url":"https://api.github.com/repos/shakacode/react_on_rails/issues/161","number":161,"state":"open","locked":false,"title":"add more detailed description when adding --help option to generator.","user":{"login":"yorzi","id":38976,"avatar_url":"https://avatars.githubusercontent.com/u/38976?v=3","gravatar_id":"","url":"https://api.github.com/users/yorzi","html_url":"https://github.com/yorzi","followers_url":"https://api.github.com/users/yorzi/followers","following_url":"https://api.github.com/users/yorzi/following{/other_user}","gists_url":"https://api.github.com/users/yorzi/gists{/gist_id}","starred_url":"https://api.github.com/users/yorzi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/yorzi/subscriptions","organizations_url":"https://api.github.com/users/yorzi/orgs","repos_url":"https://api.github.com/users/yorzi/repos","events_url":"https://api.github.com/users/yorzi/events{/privacy}","received_events_url":"https://api.github.com/users/yorzi/received_events","type":"User","site_admin":false},"body":"Refers to: #159 \r\n\r\nResult as below:\r\n\r\n```\r\nrails g react_on_rails:install --help\r\nUsage:\r\n  rails generate react_on_rails:install [options]\r\n\r\nOptions:\r\n  -R, [--redux], [--no-redux]                          # Install Redux gems and Redux version of Hello World Example. Default: false\r\n  -S, [--server-rendering], [--no-server-rendering]    # Add necessary files and configurations for server-side rendering. Default: false\r\n  -j, [--skip-js-linters], [--no-skip-js-linters]      # Skip installing JavaScript linting files. Default: false\r\n  -L, [--ruby-linters], [--no-ruby-linters]            # Install ruby linting files, tasks, and configs. Default: false\r\n  -H, [--heroku-deployment], [--no-heroku-deployment]  # Install files necessary for deploying to Heroku. Default: false\r\n  -b, [--skip-bootstrap], [--no-skip-bootstrap]        # Skip integrating Bootstrap and don't initialize files and regarding configs. Default: false\r\n\r\nRuntime options:\r\n  -f, [--force]                    # Overwrite files that already exist\r\n  -p, [--pretend], [--no-pretend]  # Run but do not make any changes\r\n  -q, [--quiet], [--no-quiet]      # Suppress status output\r\n  -s, [--skip], [--no-skip]        # Skip files that already exist\r\n\r\nDescription:\r\n\r\nThe react_on_rails:install generator combined with the example pull requests of generator runs\r\nwill get you up and running efficiently. There's a fair bit of setup with integrating Webpack\r\nwith Rails. Defaults for options are such that the default is for the flag to be off. For example,\r\nthe default for -R is that redux is off, and the default of -b means that skip-bootstrap is off.\r\n\r\n* Redux\r\n\r\n    If you have used the --redux generator option, you will notice the familiar additional redux\r\n    folders in addition to the aforementioned folders. The Hello World example has also been modified\r\n    to use Redux.\r\n\r\n    Note the organizational paradigm of \"bundles\". These are like application domains and are used\r\n    for grouping your code into webpack bundles, in case you decide to create different bundles for\r\n    deployment. This is also useful for separating out logical parts of your application. The concept\r\n    is that each bundle will have it's own Redux store. If you have code that you want to reuse across\r\n    bundles, including components and reducers, place them under /client/app/lib.\r\n\r\n* Using Images and Fonts\r\n\r\n    The generator has amended the folders created in client/assets/ to Rails's asset path. We recommend\r\n    that if you have any existing assets that you want to use with your client code, you should move\r\n    them to these folders and use webpack as normal. This allows webpack's development server to have\r\n    access to your assets, as it will not be able to see any assets in the default Rails directories\r\n    which are above the /client directory.\r\n\r\n    Alternatively, if you have many existing assets and don't wish to move them, you could consider\r\n    creating symlinks from client/assets that point to your Rails assets folders inside of app/assets/.\r\n    The assets there will then be visible to both Rails and webpack.\r\n\r\n* Bootstrap Integration\r\n\r\n    React on Rails ships with Twitter Bootstrap already integrated into the build. Note that the\r\n    generator removes require_tree in both the application.js and application.css.scss files. This\r\n    is to ensure the correct load order for the bootstrap integration, and is usually a good idea\r\n    in general. You will therefore need to explicitly require your files.\r\n\r\n    How the Bootstrap library is loaded depends upon whether one is using the Rails server or the\r\n    HMR development server.\r\n\r\n    1. Bootstrap via Rails Server\r\n\r\n        In the former case, the Rails server loads bootstrap-sprockets, provided by the bootstrap-sass\r\n        ruby gem (added automatically to your Gemfile by the generator) via the\r\n        `app/assets/stylesheets/_bootstrap-custom.scss` partial.\r\n\r\n        This allows for using Bootstrap in your regular Rails stylesheets. If you wish to customize any\r\n        of the Bootstrap variables, you can do so via the client/assets/stylesheets/_pre-bootstrap.scss partial.\r\n\r\n    2. Bootstrap via Webpack Dev Server\r\n\r\n        When using the webpack dev server, which does not go through Rails, bootstrap is loaded via the\r\n        `bootstrap-sass-loader` which uses the `client/bootstrap-sass-config.js` file.\r\n\r\n    3. Keeping Custom Bootstrap Configurations Synced\r\n\r\n        Because the webpack dev server and Rails each load Bootstrap via a different file (explained in the\r\n        two sections immediately above), any changes to the way components are loaded in one file must also\r\n        be made to the other file in order to keep styling consistent between the two. For example, if an\r\n        import is excluded in _bootstrap-custom.scss, the same import should be excluded in `bootstrap-sass-config.js`\r\n        so that styling in the Rails server and the webpack dev server will be the same.\r\n\r\n    4. Skip Bootstrap Integration\r\n\r\n        Bootstrap integration is enabled by default, but can be disabled by passing the --skip-bootstrap flag\r\n        (alias -b). When you don't need Bootstrap in your existing project, just skip it as needed.\r\n\r\n* Linters\r\n\r\n    The React on Rails generator can add linters and their recommended accompanying configurations to your project.\r\n    There are two classes of linters: ruby linters and JavaScript linters.\r\n\r\n* JavaScript Linters\r\n\r\n    JavaScript linters are enabled by default, but can be disabled by passing the --skip-js-linters flag (alias j),\r\n    and those that run in Node have been add to client/package.json under devDependencies.\r\n\r\n* Ruby Linters\r\n\r\n    Ruby linters are disabled by default, but can be enabled by passing the --ruby-linters flag when generating.\r\n    These linters have been added to your Gemfile in addition to the the appropriate Rake tasks.\r\n\r\n    We really love using all the linters! Give them a try.\r\n\r\n* Running the Linters\r\n\r\n    To run the linters (runs all linters you have installed, even if you installed both Ruby and Node):\r\n\r\n    `rake lint`\r\n\r\n    Run this command to see all the linters available\r\n\r\n    `rake -T lint`\r\n\r\n    Here's the list:\r\n    ==========================================================\r\n    rake lint               # Runs all linters\r\n    rake lint:eslint        # eslint\r\n    rake lint:js            # JS Linting\r\n    rake lint:jscs          # jscs\r\n    rake lint:rubocop[fix]  # Run Rubocop lint in shell\r\n    rake lint:ruby          # Run ruby-lint as shell\r\n    rake lint:scss          # See docs for task 'scss_lint'\r\n    ==========================================================\r\n\r\nMore Details:\r\n\r\n    `https://github.com/shakacode/react_on_rails#generator`\r\n```","created_at":"2015-12-13T08:00:35Z","updated_at":"2015-12-14T02:53:17Z","closed_at":null,"merged_at":null,"merge_commit_sha":"3ab11496fbf747b20953e3da3dbf47ece58ab35a","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/shakacode/react_on_rails/pulls/161/commits","review_comments_url":"https://api.github.com/repos/shakacode/react_on_rails/pulls/161/comments","review_comment_url":"https://api.github.com/repos/shakacode/react_on_rails/pulls/comments{/number}","comments_url":"https://api.github.com/repos/shakacode/react_on_rails/issues/161/comments","statuses_url":"https://api.github.com/repos/shakacode/react_on_rails/statuses/e99a3c4adfadc7dbee37e7123c08a5fe32b19b06","head":{"label":"shakacode:andy/add-help-option-for-generator","ref":"andy/add-help-option-for-generator","sha":"e99a3c4adfadc7dbee37e7123c08a5fe32b19b06","user":{"login":"shakacode","id":13779463,"avatar_url":"https://avatars.githubusercontent.com/u/13779463?v=3","gravatar_id":"","url":"https://api.github.com/users/shakacode","html_url":"https://github.com/shakacode","followers_url":"https://api.github.com/users/shakacode/followers","following_url":"https://api.github.com/users/shakacode/following{/other_user}","gists_url":"https://api.github.com/users/shakacode/gists{/gist_id}","starred_url":"https://api.github.com/users/shakacode/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shakacode/subscriptions","organizations_url":"https://api.github.com/users/shakacode/orgs","repos_url":"https://api.github.com/users/shakacode/repos","events_url":"https://api.github.com/users/shakacode/events{/privacy}","received_events_url":"https://api.github.com/users/shakacode/received_events","type":"Organization","site_admin":false},"repo":{"id":41117523,"name":"react_on_rails","full_name":"shakacode/react_on_rails","owner":{"login":"shakacode","id":13779463,"avatar_url":"https://avatars.githubusercontent.com/u/13779463?v=3","gravatar_id":"","url":"https://api.github.com/users/shakacode","html_url":"https://github.com/shakacode","followers_url":"https://api.github.com/users/shakacode/followers","following_url":"https://api.github.com/users/shakacode/following{/other_user}","gists_url":"https://api.github.com/users/shakacode/gists{/gist_id}","starred_url":"https://api.github.com/users/shakacode/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shakacode/subscriptions","organizations_url":"https://api.github.com/users/shakacode/orgs","repos_url":"https://api.github.com/users/shakacode/repos","events_url":"https://api.github.com/users/shakacode/events{/privacy}","received_events_url":"https://api.github.com/users/shakacode/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/shakacode/react_on_rails","description":"Integration of React + Webpack + Rails to build Universal (Isomorphic) Apps","fork":false,"url":"https://api.github.com/repos/shakacode/react_on_rails","forks_url":"https://api.github.com/repos/shakacode/react_on_rails/forks","keys_url":"https://api.github.com/repos/shakacode/react_on_rails/keys{/key_id}","collaborators_url":"https://api.github.com/repos/shakacode/react_on_rails/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/shakacode/react_on_rails/teams","hooks_url":"https://api.github.com/repos/shakacode/react_on_rails/hooks","issue_events_url":"https://api.github.com/repos/shakacode/react_on_rails/issues/events{/number}","events_url":"https://api.github.com/repos/shakacode/react_on_rails/events","assignees_url":"https://api.github.com/repos/shakacode/react_on_rails/assignees{/user}","branches_url":"https://api.github.com/repos/shakacode/react_on_rails/branches{/branch}","tags_url":"https://api.github.com/repos/shakacode/react_on_rails/tags","blobs_url":"https://api.github.com/repos/shakacode/react_on_rails/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/shakacode/react_on_rails/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/shakacode/react_on_rails/git/refs{/sha}","trees_url":"https://api.github.com/repos/shakacode/react_on_rails/git/trees{/sha}","statuses_url":"https://api.github.com/repos/shakacode/react_on_rails/statuses/{sha}","languages_url":"https://api.github.com/repos/shakacode/react_on_rails/languages","stargazers_url":"https://api.github.com/repos/shakacode/react_on_rails/stargazers","contributors_url":"https://api.github.com/repos/shakacode/react_on_rails/contributors","subscribers_url":"https://api.github.com/repos/shakacode/react_on_rails/subscribers","subscription_url":"https://api.github.com/repos/shakacode/react_on_rails/subscription","commits_url":"https://api.github.com/repos/shakacode/react_on_rails/commits{/sha}","git_commits_url":"https://api.github.com/repos/shakacode/react_on_rails/git/commits{/sha}","comments_url":"https://api.github.com/repos/shakacode/react_on_rails/comments{/number}","issue_comment_url":"https://api.github.com/repos/shakacode/react_on_rails/issues/comments{/number}","contents_url":"https://api.github.com/repos/shakacode/react_on_rails/contents/{+path}","compare_url":"https://api.github.com/repos/shakacode/react_on_rails/compare/{base}...{head}","merges_url":"https://api.github.com/repos/shakacode/react_on_rails/merges","archive_url":"https://api.github.com/repos/shakacode/react_on_rails/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/shakacode/react_on_rails/downloads","issues_url":"https://api.github.com/repos/shakacode/react_on_rails/issues{/number}","pulls_url":"https://api.github.com/repos/shakacode/react_on_rails/pulls{/number}","milestones_url":"https://api.github.com/repos/shakacode/react_on_rails/milestones{/number}","notifications_url":"https://api.github.com/repos/shakacode/react_on_rails/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/shakacode/react_on_rails/labels{/name}","releases_url":"https://api.github.com/repos/shakacode/react_on_rails/releases{/id}","created_at":"2015-08-20T20:31:54Z","updated_at":"2015-12-14T02:12:44Z","pushed_at":"2015-12-13T10:17:56Z","git_url":"git://github.com/shakacode/react_on_rails.git","ssh_url":"git@github.com:shakacode/react_on_rails.git","clone_url":"https://github.com/shakacode/react_on_rails.git","svn_url":"https://github.com/shakacode/react_on_rails","homepage":null,"size":838,"stargazers_count":478,"watchers_count":478,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":35,"mirror_url":null,"open_issues_count":19,"forks":35,"open_issues":19,"watchers":478,"default_branch":"master"}},"base":{"label":"shakacode:master","ref":"master","sha":"5117e81c51f8b3f638510a56c139719b7cd13f5d","user":{"login":"shakacode","id":13779463,"avatar_url":"https://avatars.githubusercontent.com/u/13779463?v=3","gravatar_id":"","url":"https://api.github.com/users/shakacode","html_url":"https://github.com/shakacode","followers_url":"https://api.github.com/users/shakacode/followers","following_url":"https://api.github.com/users/shakacode/following{/other_user}","gists_url":"https://api.github.com/users/shakacode/gists{/gist_id}","starred_url":"https://api.github.com/users/shakacode/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shakacode/subscriptions","organizations_url":"https://api.github.com/users/shakacode/orgs","repos_url":"https://api.github.com/users/shakacode/repos","events_url":"https://api.github.com/users/shakacode/events{/privacy}","received_events_url":"https://api.github.com/users/shakacode/received_events","type":"Organization","site_admin":false},"repo":{"id":41117523,"name":"react_on_rails","full_name":"shakacode/react_on_rails","owner":{"login":"shakacode","id":13779463,"avatar_url":"https://avatars.githubusercontent.com/u/13779463?v=3","gravatar_id":"","url":"https://api.github.com/users/shakacode","html_url":"https://github.com/shakacode","followers_url":"https://api.github.com/users/shakacode/followers","following_url":"https://api.github.com/users/shakacode/following{/other_user}","gists_url":"https://api.github.com/users/shakacode/gists{/gist_id}","starred_url":"https://api.github.com/users/shakacode/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shakacode/subscriptions","organizations_url":"https://api.github.com/users/shakacode/orgs","repos_url":"https://api.github.com/users/shakacode/repos","events_url":"https://api.github.com/users/shakacode/events{/privacy}","received_events_url":"https://api.github.com/users/shakacode/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/shakacode/react_on_rails","description":"Integration of React + Webpack + Rails to build Universal (Isomorphic) Apps","fork":false,"url":"https://api.github.com/repos/shakacode/react_on_rails","forks_url":"https://api.github.com/repos/shakacode/react_on_rails/forks","keys_url":"https://api.github.com/repos/shakacode/react_on_rails/keys{/key_id}","collaborators_url":"https://api.github.com/repos/shakacode/react_on_rails/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/shakacode/react_on_rails/teams","hooks_url":"https://api.github.com/repos/shakacode/react_on_rails/hooks","issue_events_url":"https://api.github.com/repos/shakacode/react_on_rails/issues/events{/number}","events_url":"https://api.github.com/repos/shakacode/react_on_rails/events","assignees_url":"https://api.github.com/repos/shakacode/react_on_rails/assignees{/user}","branches_url":"https://api.github.com/repos/shakacode/react_on_rails/branches{/branch}","tags_url":"https://api.github.com/repos/shakacode/react_on_rails/tags","blobs_url":"https://api.github.com/repos/shakacode/react_on_rails/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/shakacode/react_on_rails/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/shakacode/react_on_rails/git/refs{/sha}","trees_url":"https://api.github.com/repos/shakacode/react_on_rails/git/trees{/sha}","statuses_url":"https://api.github.com/repos/shakacode/react_on_rails/statuses/{sha}","languages_url":"https://api.github.com/repos/shakacode/react_on_rails/languages","stargazers_url":"https://api.github.com/repos/shakacode/react_on_rails/stargazers","contributors_url":"https://api.github.com/repos/shakacode/react_on_rails/contributors","subscribers_url":"https://api.github.com/repos/shakacode/react_on_rails/subscribers","subscription_url":"https://api.github.com/repos/shakacode/react_on_rails/subscription","commits_url":"https://api.github.com/repos/shakacode/react_on_rails/commits{/sha}","git_commits_url":"https://api.github.com/repos/shakacode/react_on_rails/git/commits{/sha}","comments_url":"https://api.github.com/repos/shakacode/react_on_rails/comments{/number}","issue_comment_url":"https://api.github.com/repos/shakacode/react_on_rails/issues/comments{/number}","contents_url":"https://api.github.com/repos/shakacode/react_on_rails/contents/{+path}","compare_url":"https://api.github.com/repos/shakacode/react_on_rails/compare/{base}...{head}","merges_url":"https://api.github.com/repos/shakacode/react_on_rails/merges","archive_url":"https://api.github.com/repos/shakacode/react_on_rails/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/shakacode/react_on_rails/downloads","issues_url":"https://api.github.com/repos/shakacode/react_on_rails/issues{/number}","pulls_url":"https://api.github.com/repos/shakacode/react_on_rails/pulls{/number}","milestones_url":"https://api.github.com/repos/shakacode/react_on_rails/milestones{/number}","notifications_url":"https://api.github.com/repos/shakacode/react_on_rails/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/shakacode/react_on_rails/labels{/name}","releases_url":"https://api.github.com/repos/shakacode/react_on_rails/releases{/id}","created_at":"2015-08-20T20:31:54Z","updated_at":"2015-12-14T02:12:44Z","pushed_at":"2015-12-13T10:17:56Z","git_url":"git://github.com/shakacode/react_on_rails.git","ssh_url":"git@github.com:shakacode/react_on_rails.git","clone_url":"https://github.com/shakacode/react_on_rails.git","svn_url":"https://github.com/shakacode/react_on_rails","homepage":null,"size":838,"stargazers_count":478,"watchers_count":478,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":35,"mirror_url":null,"open_issues_count":19,"forks":35,"open_issues":19,"watchers":478,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/shakacode/react_on_rails/pulls/161"},"html":{"href":"https://github.com/shakacode/react_on_rails/pull/161"},"issue":{"href":"https://api.github.com/repos/shakacode/react_on_rails/issues/161"},"comments":{"href":"https://api.github.com/repos/shakacode/react_on_rails/issues/161/comments"},"review_comments":{"href":"https://api.github.com/repos/shakacode/react_on_rails/pulls/161/comments"},"review_comment":{"href":"https://api.github.com/repos/shakacode/react_on_rails/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/shakacode/react_on_rails/pulls/161/commits"},"statuses":{"href":"https://api.github.com/repos/shakacode/react_on_rails/statuses/e99a3c4adfadc7dbee37e7123c08a5fe32b19b06"}}}}