Giter Club home page Giter Club logo

kanban's Introduction

Kanban

This directory contains the data and the tool to create an electronic version of a Kanban card wall. The data is in the file data.txt, the tool is the file kanban, the output goes to the html directory.

In order to run the tool install ruby and bundler (gem install bundler). Then run bundle in this directory to install the required dependencies.

The input file "data.txt" contains a definition of the board, which columns are on it, and which limits they have, as well as all the items, which are on the board. It uses a simple markdown like text format, where the columns are represented as sections, and each item by its own line.

The format of an item is:

* <name of item> (<attributes>)

where is the display name of the item, and is a comma-separated list of attributes.

The following attributes are supported:

#<tag> - An arbitrary tag for the item. Tags also define classes of service,
         which are put into their respective swim lanes. Valid values for
         classes of service are #emergency, #bug, #feature, and #maintenance.

bnc#<bugzilla id> - The id of a Bugzilla entry, which is associated with the
                    item.

in:<date> - The date the item was put into the "In" column in ISO format.

due:<date> - The date the item has to be in the "Done" column. in ISO
             format. Most items don't have a due entry.

done:<date> - The date the item was put into the "Done" column in ISO format.

trashed:<date> - The date the item was removed from the board in ISO format
                 for other reasons than being done.

@<user id> - User id of a person working on the item. There can be more than
             one user associated with an item.

Items are listed in the column, which is represented by the section in which they are in the input file. To move an item from one column to another its line is simply moved to another section in the input file.

To create the output file as HTML file showing the card wall, run the kanban tool with the input file as argument. It will write to the html directory:

./bin/kanban data.txt

Limits are automatically calculated and shown on the wall, violations are indicated by red text.

Here is an example of how a generated board looks like:

Screenshot example board

kanban's People

Contributors

cornelius avatar lmmx avatar

Stargazers

Henry Linder avatar Daniel Tlamka avatar Denys avatar Adrien avatar Chatchai Saratakij avatar Zaki Mughal [sivoais] avatar  avatar zeichenkette avatar Felix Gruber avatar Vladislav Bauer avatar Philipp Jahoda avatar Kenytt Avery avatar devsmt avatar  avatar Suraj N. Kurapati avatar David Gil avatar Javier Aranda avatar

Watchers

James Cloos avatar  avatar Marcos Luna avatar

Forkers

lmmx

kanban's Issues

Missing installation instructions

This looks very good and is just what I'm looking for for my day to day work. However, just doing a git clone and try to run fails. As for others who like me are not Ruby developers I see a need for a more extensive instruction on how to get it to run on your machine.

Without any preconfigurations or installations I get:
/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:55:in `require': cannot load such file -- haml (LoadError)

I'm running Fedora 27 and have tried several instructions online on how to install Ruby but none so far has made it possible to run:

./bin/kanban data.txt

I understand this might be a dropped project but I'm giving this issue a try.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.