Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://gitlab.com/ganttlab/ganttlab
A live Gantt chart for GitLab and GitHub https://www.ganttlab.com
https://gitlab.com/ganttlab/ganttlab
Last synced: 28 days ago
JSON representation
A live Gantt chart for GitLab and GitHub https://www.ganttlab.com
- Host: gitlab.com
- URL: https://gitlab.com/ganttlab/ganttlab
- Owner: ganttlab
- License: apache-2.0
- Created: 2020-04-23T08:43:41.559Z (over 4 years ago)
- Default Branch: master
- Last Synced: 2024-08-04T01:11:24.545Z (4 months ago)
- Stars: 101
- Forks: 20
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-robotic-tooling - GanttLab - The easy to use, fully functional Gantt chart for GitLab and GitHub. (Documentation and Presentation)
- awesome-robotic-tooling - GanttLab - The easy to use, fully functional Gantt chart for GitLab and GitHub. (Documentation and Presentation)
README
# GanttLab
The easy to use, fully functional Gantt chart for GitLab and GitHub.
## Use it now!
Simply head to https://app.ganttlab.com and pick your data source.
- **GitLab** user? Type-in your GitLab instance URL (defaults to https://gitlab.com), a [Personal Access Token](https://gitlab.com/-/profile/personal_access_tokens) with the `api` scope and enjoy!
- working with **GitHub**? Provide one of your GitHub user [Personal access tokens](https://github.com/settings/tokens) with the `repo` scope to get in!
**Safe to run:** GanttLab does NOT store any of your data on a server, and runs on YOUR browser only. It uses your own network, as if you were sending all the requests to your GitLab instance or to GitHub right from your local computer. Unsure of it? Have a look at [the source code](https://gitlab.com/ganttlab/ganttlab/tree/master).
**PRO tip:** if you are running an unsecured HTTP instance of GitLab, head to http://app.ganttlab.com to avoid your browser blocking the request coming from an HTTPS secured site.
> Interested in running GanttLab yourself? Head to the [Download and Install](docs/download-and-install.md) documentation.
## How it works
GanttLab is a **frontend only** application, built as a static website. It leverages [GitLab API](https://gitlab.com/help/api/README.md) or [GitHub API](https://developer.github.com/v3/) to read issues, before simply displaying a Gantt chart view from those issues. The automatically generated [Gantt chart](https://en.wikipedia.org/wiki/Gantt_chart) will display each issue within a "date area": from a **start date** to a **due date**. For a better user experience, there are pre-implemented rules to calculate those dates and ensure a default Gantt chart will be created without any further action:
| Each issue **start date**: | Each issue **due date**: |
|----------------------------|--------------------------|
| 1. is read from the `GanttStart` value in the issue description, | 1. is read from the `GanttDue` value in the issue description, |
| 2. _(GitLab only)_ or fallbacks to the issue milestone start date, | 2. _(GitLab only)_ or fallbacks to the issue due date, |
| 3. ultimately defaults to the issue creation date. | 3. _(GitLab only)_ or to the issue milestone due date, |
| | 4. ultimately defaults to the day after the issue start date, simulating all your issues have to be done in one day. |
You consequently have maximum control over your issues and tasks management in the Gantt chart **right from your issue description** with those two simple [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates) `YYYY-MM-DD` calendar dates:
```
GanttStart: 2020-04-27
GanttDue: 2020-05-08
```
The `GanttStart` and `GanttDue` values must each be on one dedicated line of your issue description, and if found will be considered as the _single source of truth_ to generate the Gantt chart.
**PRO tip:** the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates) format also covers times and timezones, and GanttLab will use the time information if provided (default to 12:00:00AM midnight UTC). Feel free to add _down to the second_ based `GanttStart` and `GanttDue` like `2020-06-20T14:00:00+02:00` for UTC+2, `2020-05-15T04:00:00-04:00` in UTC-4 or `2020-04-27T04:00:00Z` for UTC/GMT.
Only your opened issues are displayed. If an issue due date is past, the issue is marked late and **colored red**. If not, the issue is **shown green** as being on time.
## Contributing
GanttLab is an open source project: your contribution is greatly appreciated! First make sure to have a look at the [CONTRIBUTING guide](CONTRIBUTING.md).
## Credits
The real list is quite long, but here are some key credits to people and tools that particularly helped make GanttLab what it is:
- Florian Roscheck for his awesome work on [Visavail.js](https://github.com/flrs/visavail) on top of [D3.js](https://d3js.org/)
- The [TypeScript](https://www.typescriptlang.org/) community
- Evan You and the [Vue.js](http://vuejs.org/) community and ecosystem
- Adam Wathan and the [Tailwind CSS](https://tailwindcss.com/) community
- The GitLab [Team](https://about.gitlab.com/team/) & [Community](https://about.gitlab.com/community/), and [GitHub, Inc.](https://github.com/)
- Uncle Bob's inspirational [Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)
## License
The GanttLab application is distributed under the [Apache License, Version 2.0](LICENSE). Please have a look at the dependencies licenses if you plan on using, building, or distributing this application.