burnchart/README.md

41 lines
1.0 KiB
Markdown
Raw Normal View History

2013-08-11 18:51:19 +00:00
#GitHub Burndown Chart
##Rework in Progress
2012-09-17 10:33:48 +00:00
2013-08-11 18:51:19 +00:00
##Project Charter
2012-09-17 10:33:48 +00:00
2013-08-11 18:51:19 +00:00
The app is to display a burndown chart from a set of GitHub issues in a milestone.
2012-05-23 15:17:39 +00:00
2013-08-11 18:51:19 +00:00
If we can, do all processing and storage on the client which makes the app run for "free" on `gh-pages` etc.
2012-05-23 15:17:39 +00:00
2013-08-11 18:51:19 +00:00
Show:
2012-05-23 15:17:39 +00:00
2013-08-11 18:51:19 +00:00
* Upcoming issues by size.
* Issues closed today.
* For each issue show other tags and assignee (avatar).
* Number of working days left.
2012-05-23 15:17:39 +00:00
2013-08-11 18:51:19 +00:00
Allow:
2012-05-23 15:17:39 +00:00
2013-08-11 18:51:19 +00:00
* Toggle non working days.
* Have a print view.
* Customization of the theme (own logo/colors etc.).
2012-05-23 15:17:39 +00:00
2013-08-11 18:51:19 +00:00
Configure:
2012-05-23 15:17:39 +00:00
2013-08-11 18:51:19 +00:00
* Repos for users/orgs.
* Private api keys.
* Non working days.
* Label pattern to determine size (?).
* How often to poll for updates (limited by GH API).
2012-05-23 15:17:39 +00:00
2013-08-11 18:51:19 +00:00
Be:
2012-09-17 08:11:27 +00:00
2013-08-11 18:51:19 +00:00
* Responsive.
* As lightweight as possible (do we need Backbone/jQuery?).
* Well documented and modularized.
2013-08-11 18:51:19 +00:00
Usage envisaged in these three scenarios:
2013-08-11 18:51:19 +00:00
1. Use the `gh-pages` branch of this repo to connect and visualize a public repo.
1. Deploy the app on a static server elsewhere with custom `config`.
1. Proxy requests through a service to not disclose private api keys publicly.