DC娱乐网

让任意git仓库变成架构图快速学习

还在为看不懂庞大代码库而头疼?把 GitHub 地址里的 hub 改成 diagram,回车——秒得一张可点击的交互式架

还在为看不懂庞大代码库而头疼?

把 GitHub 地址里的 hub 改成 diagram,回车——秒得一张可点击的交互式架构图。这就是 GitDiagram 的魔法。

它能做什么?

• 即时可视化

任意公开或私有仓库,啪一下变成 Mermaid 架构图,文件夹、模块关系一目了然。

• 想点哪里点哪里

图上的每个方块都能点——直接跳到对应的源码或目录,再也不用层层翻文件夹。

• ⚡ 生成飞快

背后调用 OpenAI 最新模型 o4-mini,几秒内就把代码树 + README 吃干抹净,吐出整洁图解。

• 说改就改

对图不满意?在输入框里追加一句“把数据库层画详细点”,立刻重新生成。

• 还有 API(测试中)

想把自动生图塞进自己的 CI 或文档?公开 API 已在路上。

⚙️ 技术栈一览

• 前端:Next.js + TypeScript,Tailwind 负责颜值,ShadCN 提供组件。

• 后端:FastAPI 领衔,Python 打主力。

• 数据库:PostgreSQL,Drizzle ORM 当司机。

• AI 引擎:OpenAI o4-mini(之前用过 Claude 3.5 Sonnet)。

• 部署:前端丢 Vercel,后端放 EC2;GitHub Actions 一键发版。

• 数据打点:PostHog + Api-Analytics,用来盯性能与用量。

作者为什么写它?

Ahmed Khaleel 想给开源项目做贡献,却被巨型代码库劝退。

“要是有张地图就好了!”——于是他干脆自己画了一张能自动生成的地图。

核心思路简单粗暴:把文件树和 README 塞给大模型,再用提示词工程让它输出 Mermaid 代码。所有“魔法”都躺在 /backend/app/prompts.py 里,欢迎围观。

私有仓库也能画

点顶部“Private Repos”按钮,按提示生成一个带 repo 权限的 GitHub Personal Access Token,粘贴进去即可。

数据只在当下会话用,不会偷偷存代码。

️ 想本地跑?七步搞定

1. 克隆

git clone https://github.com/ahmedkhaleel2004/gitdiagram.git

cd gitdiagram

2. 装依赖

前端 pnpm i,后端 pip install -r requirements.txt。

3. 配环境

把 .env.example 抄成 .env,填上 OpenAI/Anthropic 密钥和可选的 GitHub Token。

4. 起后端

docker-compose up --build -d

默认开在 localhost:8000。

5. 拉数据库

chmod +x start-database.sh && ./start-database.sh

按提示生成密码,Postgres 在 localhost:5432 等你。

6. 初始化表结构

pnpm db:push

想图形化查看?跑 pnpm db:studio。

7. 启前端

pnpm dev

打开 localhost:3000,就能随意生图。

想调速率限制,改 backend/app/routers/generate.py 里的装饰器即可。

速率 & 未来

目前作者自掏腰包托管,不限速、不限量,但爱心发电总有上限,后续可能引入额度。

下一步打算:

• 给图表加上 Font Awesome 图标,颜值再 +1。

• 做“嵌入式小挂件”,类似 star-history 那种,还能随着 commit 自动更新图表。

贡献 & 致谢

欢迎提 PR 或开 Issue。

灵感及部分样式来自 Romain Courtois 的 Gitingest

github.com/romain-courtois/gitingest。

‬总结

仓库太大看不懂?把“hub”换成“diagram”,让 AI 给你画张“代码地图”,点击就能直达源码!