TargetProcess sprint

TargetProcess sprint info widget for Dashing-JS

View the Project on GitHub kj187/dashing-targetprocess_sprint

TargetProcess sprint widget

Author: Julian Kleinhans ยท Blog: http://blog.kj187.de

Dashing-JS is a NodeJS port of Dashing, an Sinatra based framework that lets you build beautiful dashboards.

The TargetProcess sprint widget is a small widget which provides the team the end date of the current sprint and their left working days count.

Preview

TargetProcess sprint widget

Example Dashboard

Example

Requirements

Dashing-JS

$ npm install -g dashing-js

Widget dependencies

$ npm install tp-api
$ npm install cron
$ npm install strsplit
$ npm install moment

Installation

$ dashing-js install https://github.com/kj187/dashing-targetprocess_sprint/archive/master.zip

Create a new directory config on your root directory. Move the widgets/targetprocess_sprint/config.targetprocess_sprint.sample.js file to this directory and rename it to config.targetprocess_sprint.js.

assets/
  ...
config/
  config.targetprocess_sprint.js
  ...
dashboards/
  ...
jobs/
  ...
...

Usage

To include the widget on your dashboard, add the following snippet to the dashboard layout file:

<li data-row="1" data-col="1" data-sizex="1" data-sizey="1">
  <div data-id="targetprocess_sprint" data-view="TargetprocessSprint"></div>
  <i class="fa fa-clock-o icon-background"></i>
</li>

Or if you use Jade as your favorite template engine 

li(data-row='1', data-col='1', data-sizex='1', data-sizey='1')
  div(data-id='targetprocess_sprint', data-view='TargetprocessSprint', class='widget')
  i(class='fa fa-clock-o icon-background')

Settings

module.exports = {

    eventName: 'targetprocess_sprint',
    cronInterval: '15 * * * * *',

    api: {
        host: 'www.host.com',
        context: '2439DD66D093095E290CF98FB987D4B7',
        version: '1',
        protocol: 'https',
        token: 'bcdefabcdefabcdefgbcdefabcdefabcdefg'
        // or instead of an API token
        // username: '',
        // password: '',
    }
}

Global settings

Setting Example Description
eventName github_pullrequests Event name, must be the same as the data-id attribute
cronInterval 1 * * * * * Click here for available cron patterns

API settings

Setting Example Description
host www.host.com Host of your TargetProcess
protocol https Http or https
context 2439DD66D093095E290CF98FB987D4B7 ACID ID if you want to fetch something from a specific project
version 1 TargetProcess API version, dont change
token bcdefabcdefabcdefgbcdefabcdefabcdefg TargetProcess API token
username julian.kleinhans If you dont have an API token, you can also use your username/password. But I highly recommend to use an API token
password xxxxxxx Your TargetProcess password

Changelog

release-1.0.0

Other Dashing-JS widgets

Do you know that I also created some other Dashing-JS widgets? Try out