Skip to content
This repository has been archived by the owner on Aug 27, 2019. It is now read-only.

Latest commit

 

History

History
78 lines (52 loc) · 2.83 KB

README.md

File metadata and controls

78 lines (52 loc) · 2.83 KB
Raw

Trello Card Tracker

Build Status

Code Climate

codecov.io

Content of a Trello board for the agile BPA.

Features

Full Documentation

Stage Manager

Takes a yaml file of a list of stages and expected times of completion and builds Trello lists in the order of the file. The stage manager will also close all lists that are not in the stages file.

Card Recorder

Will add comments to cards to see how long a card has taken to update.

Card Creator

Will create cards that correspond to a particular order listed in an order file.

Installation

git clone https://github.com/18F/trello-card-tracker
cd trello-card-tracker
npm install

Set the following ENV variables. Can be loaded from a .env file.

TRELLO_API_KEY
TRELLO_API_TOK
TRELLO_BOARD_ID
TRELLO_BPA_TEST_BOARD
TRELLO_TEST_CARD

Running

Either npm start to run the server that will run a daily call to the card-recorder with the default file stages.yaml.

Or run the cli.

node cli.js [options]

  • -s Run the stage manager class with an optional stages file parameter. Without the file it will default to data/stages.yaml.

  • -r Run the card recorder with an optional stages file parameter. Without the file it will default to data/stages.yaml.

  • -c Run the card creator with an optional stages file parameter. Without the file it will default to data/stages.yaml.

  • -i To allow the use of a Trello board ID other than the one included in the .env file.

  • -b to run the build comment command line utility. Use the following flags -l "Name of List" -f "MM/DD/YYYY" -t "MM/DD/YYYY" -o totalDays, -d (Optional) Name of list if would like to use another list to calculate the expected time.

Development

Use the develop branch

git clone https://github.com/18F/trello-card-tracker.git
git fetch origin develop
npm install --dev
npm start

Run the Mocha/Chai tests run via Istanbul. npm test

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.