GitHub Burndown Chart as a Service http://radekstepan.com/burnchart
Go to file
Radek Stepan 55654f762f test store push 2016-01-26 18:51:10 +01:00
bin docs 2016-01-26 12:45:23 +01:00
public fix milestones created after issue close; closes #100 2016-01-26 17:31:41 +01:00
src test store push 2016-01-26 18:51:10 +01:00
test test store push 2016-01-26 18:51:10 +01:00
.babelrc skeleton with latest React 2016-01-12 14:55:48 +01:00
.gitignore docs 2016-01-26 12:45:23 +01:00
.nvmrc skeleton with latest React 2016-01-12 14:55:48 +01:00
.travis.yml travis ci 2016-01-26 17:52:53 +01:00
LICENSE docs 2016-01-26 12:45:23 +01:00
Makefile serve through npm, dev and gh-pages; closes #106 2016-01-26 12:17:40 +01:00
README.md travis badge and link 2016-01-26 18:03:55 +01:00
index.html serve through npm, dev and gh-pages; closes #106 2016-01-26 12:17:40 +01:00
package.json docs 2016-01-26 12:45:23 +01:00
screenshots.jpg docs 2016-01-26 12:45:23 +01:00

README.md

#burnchart

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

Build Status 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.

##Quickstart

$ npm install burnchart -g
$ burnchart --port 8080
# burnchart/3.0.0 started on port 8080

##Configuration

At the moment, there is no ui exposed to change the app settings. You have to edit the src/config.js 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+)$/

##Development

To run your local version of the app, install all the NPM dependencies, watch the source files in one window, and start the static file server in the other in --dev mode.

$ nvm use
$ npm install
$ make watch
$ make start-dev
# burnchart/3.0.0 (dev) started on port 8080

###GitHub Pages

To serve the app from GitHub Pages that are in sync with master branch, add these two lines to .git/config, in the [remote "origin"] section:

[remote "origin"]
  fetch = +refs/heads/*:refs/remotes/origin/*
  url = git@github.com:user/repo.git
  push = +refs/heads/master:refs/heads/gh-pages
  push = +refs/heads/master:refs/heads/master