Skip to content
This repository has been archived by the owner on Apr 27, 2021. It is now read-only.

Latest commit

 

History

History
55 lines (36 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 1.42 KB
Raw

Setup

Install ruby and dependencies (rbenv recommended):

bundle install

Install node.js and dependencies:

npm install
npm install -g grunt-cli

Install bower and dependencies:

npm install -g bower
bower install

From chrome://extensions, be sure that Developer mode is enabled (in the top right of the page) and select the app/ directory via the Load unpacked extension... button. You're now ready to go!

Development

sherlocke-chrome uses a set of Grunt tasks generated by Yeoman:

grunt debug

  • Watch files for changes and...
    • Check JavaScript code quality via JSHint as specified in .jshintrc
    • Compile Sass via Compass
    • Reload the extension upon file changes via a local livereload server on port 35729

grunt test

  • Start a test server on port 9000
  • Load and run mocha tests on test/index.html

grunt build

  • Concatenate and minify resources into dist/
  • Create a distributable .zip in package/

grunt

  • Check JavaScript code quality via JSHint as specified in .jshintrc
  • Perform grunt test
  • Perform grunt build

AngularJS

We're using angularjs-styleguide