Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 2.96 KB

README.md

File metadata and controls

69 lines (43 loc) · 2.96 KB
Raw

burnchart

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

Netlify Status

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. Off days; specify which days of the week to leave out from ideal burndown progression line.
  4. Trend line; to see if you can make it to the deadline at this pace.
  5. Different point counting strategies; select from 1 issues = 1 point or read size from issue label.

Quickstart

$ yarn install
$ ./cli.js --port 1234
# burnchart/4.0.0 started on port 1234

FAQ

Browser 404 Errors

If you are running a dev mode on localhost (yarn start) and start the app by navigating to a URL that contains a . character - Vite serves a 404. To fix this either navigate to the page through homepage or start the app through the cli - yarn start:preview.

GitHub Bugs

Some milestones show "incorrect" issues associated. Consider the two following views of a milestones:

Configuration

At the moment, there is no UI exposed to change the app settings. You have to either edit the src/config.js file or use URL query string parameters to override these on a per-user basis.

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+)$/

Firebase

Signup for Firebase and go to your console and create a new project there.

You can leave the Database/Storage section as is, you only want to configure your "Authentication". There, enable "GitHub" and add your domain in "Authorised domains". Mine is set to radekstepan.com and type: Custom. If you want to run the app locally, you may want to add localhost and/or 0.0.0.0 as well.

Since you are using your own Firebase project, you want to copy a couple of keys/ids into the firebase.* section of src/config.js.

  • firebase.apiKey is "Web API key" from the "Settings" page (in "Project Overview")
  • firebase.authDomain is one of the authorised domains in "Authentication", then "Sign-in method"