Update README for latest project changes

* Fixed issue with `rake ci` not linting locally
* Renamed files for consistency.
* Using `express` to indicate webpack dev server for JS
* Added docs folder and took some sections out of the main readme
* Fixed some warnings in the JS tests

Author: justin808

.scss-lint.yml

@@ -7,201 +7,20 @@ scss_files:
 exclude: 'client/node_modules/**'
 
 linters:
-#  BangFormat:
-#    enabled: true
-#    space_before_bang: true
-#    space_after_bang: false
-#
-#  BorderZero:
-#    enabled: true
-#    convention: zero # or `none`
-#
   ColorKeyword:
     enabled: false
   ColorVariable:
     enabled: false
-#
-#  Comment:
-#    enabled: true
-#
-#  DebugStatement:
-#    enabled: true
-#
-#  DeclarationOrder:
-#    enabled: true
-#
-#  DuplicateProperty:
-#    enabled: true
-#
-#  ElsePlacement:
-#    enabled: true
-#    style: same_line # or 'new_line'
-#
-#  EmptyLineBetweenBlocks:
-#    enabled: true
-#    ignore_single_line_blocks: true
-#
-#  EmptyRule:
-#    enabled: true
-#
-#  FinalNewline:
-#    enabled: true
-#    present: true
-#
   HexLength:
     enabled: true
     style: long
-
   HexNotation:
     enabled: true
     style: uppercase
-#
-#  HexValidation:
-#    enabled: true
-#
   IdSelector:
     enabled: true
-#
-#  ImportantRule:
-#    enabled: true
-#
-#  ImportPath:
-#    enabled: true
-#    leading_underscore: false
-#    filename_extension: false
-#
-#  Indentation:
-#    enabled: true
-#    allow_non_nested_indentation: false
-#    character: space # or 'tab'
-#    width: 2
-#
   LeadingZero:
     enabled: true
     style: include_zero
-#
-#  MergeableSelector:
-#    enabled: true
-#    force_nesting: true
-#
-#  NameFormat:
-#    enabled: true
-#    allow_leading_underscore: true
-#    convention: hyphenated_lowercase # or 'camel_case', or 'snake_case', or a regex pattern
-#
-#  NestingDepth:
-#    enabled: true
-#    max_depth: 3
-#
-#  PlaceholderInExtend:
-#    enabled: true
-#
-#  PropertyCount:
-#    enabled: false
-#    include_nested: false
-#    max_properties: 10
-#
-#  PropertyUnits:
-#    enabled: true
-#    global: [
-#      'ch', 'em', 'ex', 'rem',                 # Font-relative lengths
-#      'cm', 'in', 'mm', 'pc', 'pt', 'px', 'q', # Absolute lengths
-#      'vh', 'vw', 'vmin', 'vmax',              # Viewport-percentage lengths
-#      'deg', 'grad', 'rad', 'turn',            # Angle
-#      'ms', 's',                               # Duration
-#      'Hz', 'kHz',                             # Frequency
-#      'dpi', 'dpcm', 'dppx',                   # Resolution
-#      '%',                                     # Other
-#    ]
-#    properties: {}
-#
-#  PropertySortOrder:
-#    enabled: true
-#    ignore_unspecified: false
-#    separate_groups: false
-#
-#  PropertySpelling:
-#    enabled: true
-#    extra_properties: []
-#
-#  QualifyingElement:
-#    enabled: true
-#    allow_element_with_attribute: false
-#    allow_element_with_class: false
-#    allow_element_with_id: false
-#
-#  SelectorDepth:
-#    enabled: true
-#    max_depth: 3
-#
   SelectorFormat:
     enabled: false
-#    convention: hyphenated_lowercase # or 'strict_BEM', or 'hyphenated_BEM', or 'snake_case', or 'camel_case', or a regex pattern
-#
-#  Shorthand:
-#    enabled: true
-#    allowed_shorthands: [1, 2, 3]
-#
-#  SingleLinePerProperty:
-#    enabled: true
-#    allow_single_line_rule_sets: true
-#
-#  SingleLinePerSelector:
-#    enabled: true
-#
-#  SpaceAfterComma:
-#    enabled: true
-#
-#  SpaceAfterPropertyColon:
-#    enabled: true
-#    style: one_space # or 'no_space', or 'at_least_one_space', or 'aligned'
-#
-#  SpaceAfterPropertyName:
-#    enabled: true
-#
-#  SpaceBeforeBrace:
-#    enabled: true
-#    style: space # or 'new_line'
-#    allow_single_line_padding: false
-#
-#  SpaceBetweenParens:
-#    enabled: true
-#    spaces: 0
-#
-#  StringQuotes:
-#    enabled: true
-#    style: single_quotes # or double_quotes
-#
-#  TrailingSemicolon:
-#    enabled: true
-#
-#  TrailingZero:
-#    enabled: false
-#
-#  UnnecessaryMantissa:
-#    enabled: true
-#
-#  UnnecessaryParentReference:
-#    enabled: true
-#
-#  UrlFormat:
-#    enabled: true
-#
-#  UrlQuotes:
-#    enabled: true
-#
-#  VariableForProperty:
-#    enabled: false
-#    properties: []
-#
-#  VendorPrefix:
-#    enabled: true
-#    identifier_list: base
-#    additional_identifiers: []
-#    excluded_identifiers: []
-#
-#  ZeroUnit:
-#    enabled: true
-#
-#  Compass::*:
-#    enabled: false

Gemfile

@@ -51,10 +51,12 @@ gem "awesome_print"
 # It is critical to not include any of the jquery gems when following this pattern or
 # else you might have multiple jQuery versions.
 
-group :development, :test do
+group :development do
   # Access an IRB console on exceptions page and /console in development
   gem "web-console"
+end
 
+group :development, :test do
   ################################################################################
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem "spring"
@@ -82,6 +84,10 @@ group :development, :test do
   gem "pry-stack_explorer"
   gem "pry-rescue"
   gem "pry-byebug"
+
+  ################################################################################
+  # Color console output
+  gem "rainbow"
 end
 
 group :test  do

Gemfile.lock

@@ -36,14 +36,14 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.3.8)
+    addressable (2.4.0)
     archive-zip (0.7.0)
       io-like (~> 0.3.0)
     arel (6.0.3)
     ast (2.1.0)
     astrolabe (1.3.1)
       parser (~> 2.2)
-    autoprefixer-rails (6.1.1)
+    autoprefixer-rails (6.1.2)
       execjs
       json
     awesome_print (1.6.1)
@@ -52,23 +52,23 @@ GEM
     bootstrap-sass (3.3.6)
       autoprefixer-rails (>= 5.2.1)
       sass (>= 3.3.4)
-    brakeman (3.1.2)
+    brakeman (3.1.3)
       erubis (~> 2.6)
       fastercsv (~> 1.5)
       haml (>= 3.0, < 5.0)
-      highline (~> 1.6)
+      highline (>= 1.6.20, < 2.0)
       multi_json (~> 1.2)
       ruby2ruby (>= 2.1.1, < 2.3.0)
       ruby_parser (~> 3.7.0)
-      safe_yaml
+      safe_yaml (>= 1.0)
       sass (~> 3.0)
       slim (>= 1.3.6, < 4.0)
       terminal-table (~> 1.4)
     builder (3.2.2)
     bundler-audit (0.4.0)
       bundler (~> 1.2)
       thor (~> 0.18)
-    byebug (8.2.0)
+    byebug (8.2.1)
     capybara (2.5.0)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
@@ -93,10 +93,10 @@ GEM
     coffee-script-source (1.10.0)
     concurrent-ruby (1.0.0)
     connection_pool (2.2.0)
-    coveralls (0.8.9)
+    coveralls (0.8.10)
       json (~> 1.8)
       rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.10.0)
+      simplecov (~> 0.11.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
       tins (~> 1.6.0)
@@ -204,7 +204,7 @@ GEM
     rainbow (2.0.0)
     rake (10.4.2)
     rdoc (4.2.0)
-    react_on_rails (1.1.1)
+    react_on_rails (1.2.0)
       connection_pool
       execjs (~> 2.5)
       rails (>= 3.2)
@@ -250,14 +250,14 @@ GEM
       sexp_processor (~> 4.1)
     rubyzip (1.1.7)
     safe_yaml (1.0.4)
-    sass (3.4.19)
+    sass (3.4.20)
     sass-rails (5.0.4)
       railties (>= 4.0.0, < 5.0)
       sass (~> 3.1)
       sprockets (>= 2.8, < 4.0)
       sprockets-rails (>= 2.0, < 4.0)
       tilt (>= 1.1, < 3)
-    scss_lint (0.43.0)
+    scss_lint (0.43.2)
       rainbow (~> 2.0)
       sass (~> 3.4.15)
     sdoc (0.4.1)
@@ -269,7 +269,7 @@ GEM
       rubyzip (~> 1.0)
       websocket (~> 1.0)
     sexp_processor (4.6.0)
-    simplecov (0.10.0)
+    simplecov (0.11.1)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
@@ -278,10 +278,10 @@ GEM
       temple (~> 0.7.3)
       tilt (>= 1.3.3, < 2.1)
     slop (3.6.0)
-    spring (1.4.4)
+    spring (1.5.0)
     spring-commands-rspec (1.0.4)
       spring (>= 0.9.1)
-    sprockets (3.5.1)
+    sprockets (3.5.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (2.3.3)
@@ -310,11 +310,10 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)
-    web-console (2.2.1)
-      activemodel (>= 4.0)
-      binding_of_caller (>= 0.7.2)
-      railties (>= 4.0)
-      sprockets-rails (>= 2.0, < 4.0)
+    web-console (3.0.0)
+      activemodel (>= 4.2)
+      debug_inspector
+      railties (>= 4.2)
     websocket (1.2.2)
     xpath (2.0.0)
       nokogiri (~> 1.3)
@@ -350,6 +349,7 @@ DEPENDENCIES
   rails (~> 4.2)
   rails-html-sanitizer
   rails_12factor
+  rainbow
   react_on_rails
   rspec-rails
   rspec-retry

Procfile.dev

@@ -1,11 +1,20 @@
-web: rails s
+# Basic procfile for dev work.
+# Runs all processes. Development is faster if you pick one of the other Procfiles if you don't need
+# some of the processes: Procfile.rails or Procfile.express
 
+# Development rails requires both rails and rails-assets
+# (and rails-server-assets if server rendering)
+rails: rails s
 # Run the hot reload server for client development
-client: sh -c 'rm app/assets/webpack/* || true && cd client && HOT_RAILS_PORT=3500 npm run build:dev:client'
+rails-assets: sh -c 'rm app/assets/webpack/* || true && HOT_RAILS_PORT=3500 npm run build:dev:client'
+# Keep the JS fresh for server rendering. Remove if not server rendering
+rails-server-assets: sh -c 'npm run build:dev:server'
 
-# Keep the JS fresh for specs
-client-spec: sh -c 'cd client && npm run build:test:client'
+# If you don't keep this process going, you will rebuild the assets per spec run. This is configured
+# in rails_helper.rb.
+rails-spec: sh -c 'npm run build:test:client'
 
-# Keep the JS fresh for server rendering
-server: sh -c 'cd client && npm run build:dev:server'
-hot: sh -c 'cd client && HOT_PORT=4000 npm start'
+# Run an express server if you want to mock out your endpoints. No Rails involved!
+# Disable this if you are not using it.
+# It's a great way to prototype UI especially with non-Rails developers!
+express: sh -c 'HOT_PORT=4000 npm start'

Procfile.express

@@ -0,0 +1,8 @@
+# Basic procfile for express server dev work.
+# Only run the express server!
+# Use this if you want to mock out your endpoints.
+# It's a great way to prototype UI especially with non-Rails developers!
+# You can still run tests, and they will build the webpack file for each test run.
+# Hot reloading of JS and CSS is enabled!
+
+express: sh -c 'HOT_PORT=4000 npm start'