0.1.0 • Published 7 years ago

kanban-js v0.1.0

Weekly downloads
-
License
GPL-3.0
Repository
github
Last release
7 years ago

Kanban.js

JavaScript library to calculate Kanban metrics

How to use

First, install it:

npm install kanbanjs

Import

Import like usual

import kanban from 'kanbanjs'

also work using require:

const kanban = require('kanbanjs')

Generating metrics

Generating lead time, cycle time, reaction time and cumulative flow diagram data:

const stories = [
  {
    "created": "2017-03-01", 
    "started": "2017-03-03",
    "finished": "2017-03-11"
  },
  {
    "created": "2017-03-07", 
    "started": "2017-03-12",
    "finished": "2017-03-17"
  },
  {
    "created": "2017-03-10", 
    "started": "2017-03-12",
    "finished": "2017-03-16"
  }
]

const metrics = kanban.metrics(stories)

// metrics: 
//  {
//    leadtime: '8.67', 
//    cycletime: '5.67',
//    cfd: {}
//  }

Building

To build the library, use npm run build. The build is produced in dist directory.

Testing

To run the library tests, use npm test

License

The General Public License 3.0 License (GPL)

0.1.0

7 years ago