jingrow/gantt
1
0
Fork 0
Code Pull Requests Activity

Update README.md

Browse Source
This commit is contained in:
Safwan Samsudeen 2024-12-12 16:08:01 +05:30 committed by GitHub
parent bb448c774f
commit e48960366f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,5 +1,5 @@
<div align="center" markdown="1"> <div align="center" markdown="1">
<img src=".github/gantt-logo.png" width="100"> <img src=".github/gantt-logo.png" width="80">
<h1>Frappe Gantt</h1> <h1>Frappe Gantt</h1>
**A modern, configurable, Gantt library for the web.** **A modern, configurable, Gantt library for the web.**
@ -10,11 +10,9 @@
</a> </a>
</div> </div>
<div align="center"> ![Hero Image](.github/hero_image.png)
<img src=".github/hero_image.png" alt="Hero Image" width="72%" />
</div>
## About ## Frappe Gantt
Gantt charts are bar charts that visually illustrate a project's tasks, schedule, and dependencies. With Frappe Gantt, you can build beautiful, customizable, Gantt charts with ease. Gantt charts are bar charts that visually illustrate a project's tasks, schedule, and dependencies. With Frappe Gantt, you can build beautiful, customizable, Gantt charts with ease.
You can use it anywhere from hobby projects to tracking the goals of your team at the worksplace. You can use it anywhere from hobby projects to tracking the goals of your team at the worksplace.
@ -22,17 +20,12 @@ You can use it anywhere from hobby projects to tracking the goals of your team a
[ERPNext](https://erpnext.com/) uses Frappe Gantt. [ERPNext](https://erpnext.com/) uses Frappe Gantt.
## Motivation ### Motivation
We needed a Gantt View for a project, but surprisingly couldn't find a visually appealing Gantt library that was open source. So we built it! I needed a Gantt View for ERPNext. Surprisingly, I couldn't find a visually appealing Gantt library that was open source - so I decided to build it. Initially, the design was heavily inspired by Google Gantt and DHTMLX.
Initially, the design was heavily inspired by Google Gantt and DHTMLX.
Today, we pride ourselves on having the most aesthetically pleasing _and_ powerful Gantt library on the market - except, of course, that it's free.
## Key Features ### Key Features
A wide variety of modes - be it day, hour, or year, you have it. Or add your own modes! - **Customizable Views**: customize the timeline based on various time periods - day, hour, or year, you have it. You can also create your own views.
- **Customizable Views**: customize the timeline based on various time periods - day, hour, or year, you have it. And if it's not covered, you can create your own!
- **Ignore Periods**: exclude weekends and other holidays from your tasks' progress calculation. - **Ignore Periods**: exclude weekends and other holidays from your tasks' progress calculation.
- **Configure Anything**: spacing, edit access, labels, you can control it all. Change both the style and functionality to meet your needs. - **Configure Anything**: spacing, edit access, labels, you can control it all. Change both the style and functionality to meet your needs.
- **Multi-lingual Support**: suitable for companies with an international base. - **Multi-lingual Support**: suitable for companies with an international base.
@ -57,7 +50,7 @@ Or from the CDN:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/frappe-gantt/dist/frappe-gantt.css"> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/frappe-gantt/dist/frappe-gantt.css">
``` ```
And start hacking: Star using Gantt:
```js ```js
let tasks = [ let tasks = [
{ {
@ -72,7 +65,8 @@ let tasks = [
let gantt = new Gantt("#gantt", tasks); let gantt = new Gantt("#gantt", tasks);
``` ```
To see the list of all options, check out [the docs](docs.frappe.io/gantt) (under development). <!-- To see the list of all options, check out [the docs](docs.frappe.io/gantt) (under development). -->
## Development Setup ## Development Setup
If you want to contribute enhancements or fixes: If you want to contribute enhancements or fixes:
@ -84,7 +78,8 @@ If you want to contribute enhancements or fixes:
5. Open `index.html` in your browser. 5. Open `index.html` in your browser.
6. Make your code changes and test them. 6. Make your code changes and test them.
<h2></h2> <br />
<br />
<div align="center" style="padding-top: 0.75rem;"> <div align="center" style="padding-top: 0.75rem;">
<a href="https://frappe.io" target="_blank"> <a href="https://frappe.io" target="_blank">
<picture> <picture>