Ganttilla

Effortless roadmap visualisation tool

How it works

The Ganttilla draws roadmap based on the JSON descriptor files in the assets directory.

To make the most of it, you can automate generation of descriptor file. This project provides scripts that turns GitLab or GitHub milestones to blocks(see the diagram below), along with links and due date. Alternatively, you can write your own script to transform any data into the format Ganttilla uses.

With script ready run it from time to time (using cron for example) to regenerate data.

Diagram of concepts

Effortless roadmap visualisation tool. Visit the demo page here to verify how it works.

How it works

The Ganttilla draws roadmap based on the JSON descriptor files in the assets directory.

Diagram of concepts

Descriptor file

GitLab/GitHub using Docker image

The fastest way to generate a descriptor is running following command:

docker run --rm -it -v ${PWD}/descriptors:/ganttilla/generated-descriptors ocadotechnology/ganttilla:latest gitlab

Available commands are github and gitlab. After answering a few questions you can find your descriptor under ${PWD}/descriptors.

GitLab

To generate descriptor files for GitLab project, set following environment variables:

GITLAB_URL

GITLAB_PROJECT_ID

GITLAB_TOKEN

GANTTILLA_OUTPUT_FILENAME

This will use milestones defined in the project and create blocks that represent them.

Then run the following script:

python scripts/run.py gitlab

GitHub

To generate descriptor files for GitHub project, set following environment variables:

GITHUB_USERNAME

GITHUB_REPOSITORY

GITHUB_TOKEN

GANTTILLA_OUTPUT_FILENAME

Then run the following script:

python scripts/run.py github

Jira

To generate descriptor files for Jira project, set following environment variables:

JIRA_PROJECT

JIRA_URL

JIRA_USERNAME

JIRA_TOKEN

JIRA_START_DATE_FIELD - usually a custom field

JIRA_END_DATE_FIELD - usually a custom field

GANTTILLA_OUTPUT_FILENAME

Set optional variable JIRA_CUSTOM_JQL if you want some customisation to your JQL query instead of just getting all issues assigned to a project.

This will use milestones defined in the project and create blocks that represent them.

The description file should contain list of objects, each one representing block of work. Take for example the src/assets/descriptors/empire.json.

Fields start_date and end_date should store dates in yyyy-MM-dd pattern. The swimlane field is optional.

[
  {
    "title": "Destroy the Death Star",
    "description": "Blow up that thing",
    "start_date": "2018-12-10",
    "end_date": "2019-03-09",
    "link": "https://github.com/ocadotechnology/ganttilla",
    "swimlane": "Freedom"
  }
]

Getting help

Having trouble with Ganttilla? We'd like to help!

• Ask a question - we monitor ganttilla/issues for questions.
• Report bugs with Ganttilla at ganttilla/issues.

Reporting Issues

Ganttilla uses GitHub's integrated issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:

• Before you log a bug, please search the issue tracker to see if someone has already reported the problem.
• If the issue doesn't already exist, create a new issue.
• Please provide as much information as possible with the issue report, we like to know the version of Ganttilla that you are using.
• If you need to paste code use Markdown ``` escapes before and after your text.
• If possible try to create a test-case or project that replicates the issue.

Quick start

You need docker installed on your computer.

To start Ganttilla with example descriptors run the following command:

docker run -dit -p 4200:80 --name ganttilla ocadotechnology/ganttilla:latest

Go to your browser and type http://localhost:4200.

To start Ganttilla with your own descriptor run the following command:

docker run -dit -p 4200:80 -v /opt/ganttilla/first-order.json:/ganttilla/descriptors/first-order.json --name ganttilla ocadotechnology/ganttilla:latest

Go to your browser and type http://localhost:4200.

Building from Source

You need npm installed on your computer.

To start the project locally run:

$ npm install
$ npm start

To build the project run:

$ npm install
$ npm run-script build

You need docker installed on your computer.

To build Docker image run:

docker build -t ocadotechnology/ganttilla:latest .

License

Ganttilla is Open Source software released under the Apache 2.0 license.

Copyright © 2018 Ocado