2.7 KiB
2.7 KiB
GitHub Burndown Chart as a Service. Answers the question "are my projects on track"?
##Features
- Running from the browser, apart from GitHub account sign in which uses Firebase backend.
- Private repos; sign in with your GitHub account.
- Store projects in browser's
localStorage. - Off days; specify which days of the week to leave out from ideal burndown progression line.
- Trend line; to see if you can make it to the deadline at this pace.
- Different point counting strategies; select from 1 issues = 1 point or read size from issue label.
##Configuration
At the moment, there is no ui exposed to change the app settings. You have to edit the src/models/config.coffee file.
An array of days when we are not working where Monday = 1. The ideal progression line won't drop on these days.
"off_days": [ ]
Choose from ONE_SIZE which means each issue is worth 1 point or LABELS where issue labels determine its size.
"points": "ONE_SIZE"
If you specify LABELS above, this is the place to set a regex used to parse a label and extract points size from it. When multiple matching size labels exist, their sum is taken.
"size_label": /^size (\d+)$/
##Commands
Read the Architecture document when contributing code.
rake build # Build everything & minify
rake build:css # Build the styles with LESS
rake build:js # Build the app with Browserify
rake build:minify # Minify build for production
rake commit[message] # Build app and make a commit with latest changes
rake install # Install dependencies with NPM
rake publish # Publish to GitHub Pages
rake serve # Start a web server on port 8080
rake test # Run tests with mocha
rake test:coverage # Run code coverage, mocha with Blanket.js
rake test:coveralls[token] # Run code coverage and publish to Coveralls
rake watch # Watch everything
rake watch:css # Watch the styles
rake watch:js # Watch the app