GitHub Burndown Chart as a Service http://radekstepan.com/burnchart
Go to file
Radek Stepan 78c9541af6 need to be keeping my eye out for these guys now 2014-11-10 20:53:11 -07:00
docs and we are back 2014-11-10 19:16:52 -07:00
public change footer 2014-11-10 20:42:16 -07:00
src change footer 2014-11-10 20:42:16 -07:00
test and we are back 2014-11-10 19:16:52 -07:00
.gitignore need to be keeping my eye out for these guys now 2014-11-10 20:53:11 -07:00
Gruntfile.coffee Clean temp folders after publishing 2014-11-02 12:27:23 -07:00
LICENSE switch all deps to browserify 2014-10-26 21:10:41 -06:00
README.md codeship id 2014-11-10 20:12:43 -07:00
Rakefile a test of detecting chart type using neural net 2014-11-09 13:34:57 -07:00
package.json and we are back 2014-11-10 19:16:52 -07:00

README.md

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.

#burnchart

GitHub Burndown Chart as a Service. Answers the question "are my projects on track"?

Build Status Coverage Dependencies License

image

##Features

  1. Running from the browser, apart from GitHub account sign in which uses Firebase backend.
  2. Private repos; sign in with your GitHub account.
  3. Store projects in browser's localStorage.
  4. Off days; specify which days of the week to leave out from ideal burndown progression line.
  5. Trend line; to see if you can make it to the deadline at this pace.
  6. 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