mirror of
https://github.com/status-im/burnchart.git
synced 2025-02-10 17:36:24 +00:00
93 lines
2.7 KiB
Markdown
93 lines
2.7 KiB
Markdown
*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](http://burnchart.io)
|
||
|
||
GitHub Burndown Chart as a Service. Answers the question "are my projects on track"?
|
||
|
||
|
||
[](<https://coveralls.io/r/radekstepan/burnchart>)
|
||
[](https://david-dm.org/radekstepan/burnchart)
|
||
[](LICENSE)
|
||
|
||
|
||
|
||
##Features
|
||
|
||
1. Running from the browser, apart from GitHub account sign in.
|
||
1. Private repos; sign in with your GitHub account.
|
||
1. Store projects in browser's `localStorage`.
|
||
1. Off days; specify which days of the week to leave out from ideal burndown progression line.
|
||
1. Trend line; to see if you can make it to the deadline at this pace.
|
||
1. 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.
|
||
|
||
```coffeescript
|
||
"off_days": [ ]
|
||
```
|
||
|
||
Choose from `ONE_SIZE` which means each issue is worth 1 point or `LABELS` where issue labels determine its size.
|
||
|
||
```coffeescript
|
||
"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.
|
||
|
||
```coffeescript
|
||
"size_label": /^size (\d+)$/
|
||
```
|
||
|
||
##Build
|
||
|
||
The app is built using [Node](http://nodejs.org/). To install dev dependencies:
|
||
|
||
```bash
|
||
$ make install
|
||
```
|
||
|
||
###Development
|
||
|
||
To create an unminified package with source maps for debugging:
|
||
|
||
```bash
|
||
$ make watch
|
||
```
|
||
|
||
You can then start a local http server with:
|
||
|
||
```bash
|
||
$ make serve
|
||
```
|
||
|
||
To test your changes run:
|
||
|
||
```bash
|
||
$ make test
|
||
```
|
||
|
||
And finally for code coverage:
|
||
|
||
```bash
|
||
$ make coverage
|
||
```
|
||
|
||
There is currently a bug that incorrectly shows code coverage (using [blanket.js](http://blanketjs.org/)) for modules that are loaded using [proxyquire](https://github.com/thlorenz/proxyquire).
|
||
|
||
###Production
|
||
|
||
To make a minified package for production:
|
||
|
||
```bash
|
||
$ make build
|
||
```
|
||
|
||
You can then publish the contents of the `public` folder to `gh-pages` branch with:
|
||
|
||
```bash
|
||
$ make publish
|
||
``` |