2.7 KiB
Existing users: The url mapping has been preserved from the original app, we are just using a different domain. If you'd like to use the previous version(s), grab the tags v1, v2.
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+)$/
##Build
The app is built using Node. To install dev dependencies:
$ make install
###Development
Read the Architecture document when contributing code.
To create an unminified package with source maps for debugging:
$ make watch
You can then start a local http server on port 8080 with:
$ make serve
To test your changes run:
$ make test
And finally for code coverage:
$ make coverage
###Production
To make a minified package for production:
$ make build
You can then publish the contents of the public folder to gh-pages branch with:
$ make publish