一个轻量级、自托管的仪表盘,用于实时监控多个 GitHub 仓库的动态(Commits, PRs, Issues 等),并将它们聚合到一个统一的视图中。
- 多仓聚合:在一个统一的仪表盘中跟踪多个 GitHub 仓库。
- 实时动态流:近实时展示 Commits、Pull Requests、Issues、Releases 等事件,并将 Push 事件中的多个 Commit 展开。
- 自定义显示名称:为仓库设置易于辨识的别名。
- 智能 API 策略:采用交错更新和 ETag 缓存,有效避免 API 速率限制,并提供详细的调试日志。
- Docker 就绪:使用 Docker Compose 实现一键启动和部署。
- 零配置前端:所有配置均通过后端的
.env文件管理,前端开箱即用。 - 智能排序:仓库概览和后端更新队列均按最近活动 (
updated_at) 自动排序。 - 亮/暗模式:自动适配你的系统主题。
-
克隆仓库
git clone https://github.com/CodeBoy2006/Github-Kanban cd Github-Kanban -
创建配置文件 从模板复制
.env文件。cp .env.example .env
-
编辑配置 打开
.env文件并填入你的配置,特别是REPOS和GITHUB_TOKEN。# .env # 仓库列表,格式为: owner/repo:显示名称,owner2/repo2:显示名称2 REPOS=vercel/next.js:🚀 Next.js,apache/superset:📊 Superset # 你的 GitHub Personal Access Token # 用于访问私有仓库或提高 API 速率限制 GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxx # 其他配置... HOST_PORT=8080
-
启动服务 使用 Docker Compose 在后台构建并启动服务。
docker-compose up -d --build
-
访问看板 打开浏览器,访问
http://localhost:8080(或你在.env中设置的HOST_PORT)。
所有配置均通过项目根目录下的 .env 文件完成。
| 变量 | 说明 | 示例 |
|---|---|---|
REPOS |
必填。要监控的仓库列表,用逗号分隔。格式:id:显示名称。 |
denoland/deno:🦕 Deno,torvalds/linux:🐧 Linux |
GITHUB_TOKEN |
强烈推荐。你的 GitHub PAT。公开仓库可不填,私有仓库必须。 | ghp_... |
REFRESH_SECONDS |
整个更新队列重新排序的全局周期(秒)。 | 300 |
REPO_UPDATE_INTERVAL_SECONDS |
更新队列中单个仓库的间隔时间(秒)。 | 10 |
HOST_PORT |
映射到主机的端口号。 | 8080 |
CONTAINER_PORT |
容器内部应用监听的端口,应与 PORT 环境变量保持一致。 |
8000 |
TZ |
(可选)设置容器的显示时区。 | Asia/Shanghai |