【亲测免费】 开源项目安装与配置指南：GitDiagram

1. 项目基础介绍

GitDiagram 是一个开源项目，它可以将任何 GitHub 仓库转化为交互式图表，以帮助开发者更好地理解和浏览代码库。该项目旨在解决开源项目代码库过于庞大，难以手动浏览的问题。GitDiagram 使用户能够通过图表的方式快速了解项目结构和组件，进而导航到相关的源文件和目录。

该项目主要使用的编程语言包括：

• TypeScript
• Python
• JavaScript
• CSS

2. 项目使用的关键技术和框架

• 前端框架：Next.js、TypeScript、Tailwind CSS、ShadCN
• 后端框架：FastAPI
• 数据库：PostgreSQL（通过 Drizzle ORM）
• 人工智能：OpenAI o3-mini（之前使用 Claude 3.5 Sonnet）
• 部署：Vercel（前端）、EC2（后端）
• 持续集成/持续部署：GitHub Actions
• 分析工具：PostHog、Api-Analytics

3. 项目安装和配置的准备工作

在开始安装之前，请确保您的系统中已安装以下工具：

• Git
• Docker
• Node.js 和 npm 或 pnpm
• Python

此外，您需要一个 GitHub 账户以及一个具有 repo 范围的 GitHub 个人访问令牌（如果您需要访问私有仓库）。

安装步骤

1. 克隆仓库

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

2. 安装依赖

   使用 pnpm 安装项目依赖：

   pnpm i
   

3. 设置环境变量

   将 .env.example 文件复制为 .env，然后编辑 .env 文件，添加您的 Anthropic API 密钥和可选的 GitHub 个人访问令牌。

   cp .env.example .env
   

4. 运行后端

   使用 Docker Compose 启动后端服务：

   docker-compose up --build -d
   

   您可以通过以下命令查看日志：

   docker-compose logs -f
   

   FastAPI 服务将在 localhost:8000 上可用。

5. 启动数据库

   给 start-database.sh 脚本添加执行权限，并运行它：

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

   当提示生成随机密码时，输入 yes。

   PostgreSQL 数据库将在 localhost:5432 上的容器中启动。

6. 初始化数据库架构

   运行以下命令初始化数据库模式：

   pnpm db:push
   

   您可以使用以下命令查看和交互数据库：

   pnpm db:studio
   

7. 运行前端

   使用 pnpm 运行前端开发服务器：

   pnpm dev
   

   现在您可以在 localhost:3000 上访问网站，并可以编辑 backend/app/routers/generate.py 中的 generate 函数装饰器来调整速率限制。

以上步骤是 GitDiagram 项目的详细安装和配置指南，按照这些步骤，您应该能够在本地成功运行该项目。