diff --git a/README.md b/README.md index 6cf9b6f..f2d8c15 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ ## 项目概述 -Code API 是一个全栈 monorepo 项目,采用 Rust 后端 + React 前端的技术栈。项目实现了类似 GitHub 的 Issue 追踪、Pull Request 代码审查、Git 仓库管理,以及类似 Slack 的实时聊天 Room 功能。 +Code API 是一个全栈 monorepo 项目,采用 Rust 后端 + React 前端的技术栈。项目实现了类似 GitHub 的 Issue 追踪、Pull Request +代码审查、Git 仓库管理,以及类似 Slack 的实时聊天 Room 功能。 ### 核心功能 @@ -19,33 +20,33 @@ Code API 是一个全栈 monorepo 项目,采用 Rust 后端 + React 前端的 ### 后端 (Rust) -| 类别 | 技术 | -|------|------| -| 语言 | Rust 2024 Edition | -| Web 框架 | Actix-web | -| ORM | SeaORM | -| 数据库 | PostgreSQL | -| 缓存 | Redis | -| 实时通信 | WebSocket (actix-ws) | -| 消息队列 | NATS | -| 向量数据库 | Qdrant | -| Git 操作 | git2 / git2-ext | -| 认证 | JWT + Session | -| API 文档 | utoipa (OpenAPI) | +| 类别 | 技术 | +|--------|----------------------| +| 语言 | Rust 2024 Edition | +| Web 框架 | Actix-web | +| ORM | SeaORM | +| 数据库 | PostgreSQL | +| 缓存 | Redis | +| 实时通信 | WebSocket (actix-ws) | +| 消息队列 | Redis | +| 向量数据库 | Qdrant | +| Git 操作 | git2 / git2-ext | +| 认证 | JWT + Session | +| API 文档 | utoipa (OpenAPI) | ### 前端 (TypeScript/React) -| 类别 | 技术 | -|------|------| -| 语言 | TypeScript 5.9 | -| 框架 | React 19 | -| 路由 | React Router v7 | -| 构建工具 | Vite 8 + SWC | -| UI 组件 | shadcn/ui + Tailwind CSS 4 | -| 状态管理 | TanStack Query | -| HTTP 客户端 | Axios + OpenAPI 生成 | -| Markdown | react-markdown + Shiki | -| 拖拽 | dnd-kit | +| 类别 | 技术 | +|----------|----------------------------| +| 语言 | TypeScript 5.9 | +| 框架 | React 19 | +| 路由 | React Router v7 | +| 构建工具 | Vite 8 + SWC | +| UI 组件 | shadcn/ui + Tailwind CSS 4 | +| 状态管理 | TanStack Query | +| HTTP 客户端 | Axios + OpenAPI 生成 | +| Markdown | react-markdown + Shiki | +| 拖拽 | dnd-kit | ## 项目结构 @@ -135,8 +136,8 @@ code/ ``` 7. **访问应用** - - 前端: http://localhost:5173 - - 后端 API: http://localhost:8080 + - 前端: http://localhost:5173 + - 后端 API: http://localhost:8080 ## 开发指南 @@ -192,21 +193,21 @@ cargo run -p migrate ### 必需配置项 -| 变量名 | 说明 | 示例 | -|--------|------|------| +| 变量名 | 说明 | 示例 | +|--------------------|---------------|---------------------------------------| | `APP_DATABASE_URL` | PostgreSQL 连接 | `postgresql://user:pass@localhost/db` | -| `APP_REDIS_URL` | Redis 连接 | `redis://localhost:6379` | -| `APP_AI_API_KEY` | AI 服务 API Key | `sk-xxxxx` | -| `APP_SMTP_*` | SMTP 邮件配置 | 见 `.env.example` | +| `APP_REDIS_URL` | Redis 连接 | `redis://localhost:6379` | +| `APP_AI_API_KEY` | AI 服务 API Key | `sk-xxxxx` | +| `APP_SMTP_*` | SMTP 邮件配置 | 见 `.env.example` | ### 可选配置项 -| 变量名 | 默认值 | 说明 | -|--------|--------|------| -| `APP_DATABASE_MAX_CONNECTIONS` | 10 | 数据库连接池大小 | -| `APP_LOG_LEVEL` | info | 日志级别 | -| `APP_QDRANT_URL` | - | 向量数据库地址 | -| `APP_REPOS_ROOT` | /data/repos | Git 仓库存储路径 | +| 变量名 | 默认值 | 说明 | +|--------------------------------|-------------|------------| +| `APP_DATABASE_MAX_CONNECTIONS` | 10 | 数据库连接池大小 | +| `APP_LOG_LEVEL` | info | 日志级别 | +| `APP_QDRANT_URL` | - | 向量数据库地址 | +| `APP_REPOS_ROOT` | /data/repos | Git 仓库存储路径 | 完整配置请参考 `.env.example`。