GitHub Gantt 项目使用教程

最新推荐文章于 2024-09-25 07:33:27 发布

潘俭渝Erik

最新推荐文章于 2024-09-25 07:33:27 发布

阅读量351

点赞数 3

本文链接：https://blog.csdn.net/gitblog_00091/article/details/139588600

版权

GitHub Gantt 项目使用教程

github-gantt Generate Gantt Charts From Github Issues! 项目地址: https://gitcode.com/gh_mirrors/gi/github-gantt

1、项目介绍

GitHub Gantt 是一个开源项目，旨在帮助组织，特别是开源团队，在 GitHub 上轻松地可视化工作时间表。通过解析 GitHub 问题中的特定搜索字符串，该项目能够识别开始/结束日期、标签和进度，并将这些数据聚合到一个 Gantt 图中。这消除了使用多个工具的必要性，简化了项目管理流程。

2、项目快速启动

2.1 环境准备

在开始之前，请确保您的系统上已安装 Node.js 和 npm。

2.2 安装步骤

克隆项目仓库：

git clone https://github.com/realm/github-gantt.git
cd github-gantt

配置服务器：运行以下命令以配置服务器：
```
# Mac
sh ./setup.sh

# Linux
bash ./setup.sh
```
该脚本将要求您输入 GitHub API 令牌、组织名称和仓库名称，并生成一个配置文件 /config/config.js。
启动服务器：
```
node index.js
```
您可以通过指定端口来启动服务器：
```
PORT=80 node index.js
```

2.3 配置文件示例

以下是配置文件 /config/config.js 的示例内容：

module.exports = {
  GITHUB_API_TOKEN: "your_github_api_token",
  GITHUB_ORG_NAME: "your_organization_name",
  GITHUB_REPO_NAME: "your_repo_name",
  START_DATE_STRING: "#### 🗓 Start Date:",
  DUE_DATE_STRING: "#### 🗓 Expected Date:",
  LABEL_STRING: "#### 🏷 Label:",
  PROGRESS_STRING: "#### 📈 Progress (0-1):"
};