# codeflow

**Repository Path**: chenxiannn/codeflow

## Basic Information

- **Project Name**: codeflow
- **Description**: 一个基于 Web 的代码审查与项目管理平台，集成了 AI 辅助代码审查、自动化工作流、团队协作等功能。
- **Primary Language**: Python
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-03-16
- **Last Updated**: 2026-03-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CodeFlow

<div align="center">

![CodeFlow Logo](docs/logo.png)

**AI-Powered Code Review Platform**

[![FastAPI](https://img.shields.io/badge/FastAPI-0.115-green?logo=python)](https://fastapi.tiangolo.com)
[![Vue 3](https://img.shields.io/badge/Vue-3.5-brightgreen?logo=vue.js)](https://vuejs.org)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.6-blue?logo=typescript)](https://www.typescriptlang.org)
[![Python](https://img.shields.io/badge/Python-3.11-blue?logo=python)](https://www.python.org)
[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16-blue?logo=postgresql)](https://www.postgresql.org)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

</div>

---

## 📖 项目简介

**CodeFlow** 是一个基于 AI 的代码审查与项目管理平台，提供智能代码分析、自动化工作流和团队协作功能。通过集成 Claude AI 的多代理审查系统，CodeFlow 能够从安全性、性能和代码风格等多个维度全面分析代码质量。

### ✨ 核心特性

- 🤖 **AI 多代理审查系统**
  - Security Agent - 安全漏洞检测
  - Performance Agent - 性能问题分析
  - Style Agent - 代码风格检查

- 🔍 **智能代码分析**
  - 自动代码质量评分 (0-100)
  - 问题严重程度分类 (critical/high/medium/low)
  - 改进建议和代码示例

- 🔄 **PR 自动化工作流**
  - Git/Gitee PR 集成
  - 自动审查和评论
  - 实时状态监控

- 👥 **团队协作**
  - 用户和权限管理
  - 项目和仓库管理
  - 审查请求和评论

- 📊 **可视化仪表板**
  - 代码质量趋势
  - 审查历史记录
  - 团队活动统计

---

## 🏗️ 技术架构

```
┌─────────────────────────────────────────────────────────────┐
│                         前端 (Frontend)                      │
│  Vue 3 + TypeScript + Vite + Pinia + Vue Router             │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                      Nginx (反向代理)                        │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                       后端 (Backend)                        │
│              FastAPI + SQLAlchemy + PostgreSQL               │
│  ┌──────────────────────────────────────────────────────┐  │
│  │              AI 审查服务 (Claude Agents)              │  │
│  │   Security Agent │ Performance Agent │ Style Agent  │  │
│  └──────────────────────────────────────────────────────┘  │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                    数据层 (Data Layer)                     │
│              PostgreSQL + Redis (缓存)                      │
└─────────────────────────────────────────────────────────────┘
```

### 技术栈详情

| 层级 | 技术选型 | 说明 |
|------|---------|------|
| **前端** | Vue 3.5 | 渐进式 JavaScript 框架 |
| | TypeScript 5.6 | 类型安全的 JavaScript |
| | Vite 6.0 | 快速的前端构建工具 |
| | Pinia 2.3 | Vue 3 状态管理 |
| | Vue Router 4.5 | 官方路由管理器 |
| | Axios 1.7 | HTTP 客户端 |
| **后端** | FastAPI 0.115 | 高性能 Python Web 框架 |
| | SQLAlchemy 2.0 | Python SQL 工具包和 ORM |
| | AsyncPG 0.30 | 异步 PostgreSQL 驱动 |
| | Alembic 1.14 | 数据库迁移工具 |
| | Pydantic 2.10 | 数据验证库 |
| | Anthropic 0.40 | Claude AI SDK |
| **数据库** | PostgreSQL 16 | 关系型数据库 |
| | Redis 7.0 | 缓存和会话存储 |
| **DevOps** | Docker | 容器化部署 |
| | Docker Compose | 多容器编排 |
| | Nginx | 反向代理和负载均衡 |

---

## 🚀 快速开始

### 环境要求

- Python 3.11+
- Node.js 20+
- PostgreSQL 16+
- Redis 7.0+ (可选)
- Docker & Docker Compose (可选)

### 安装步骤

#### 方式一：Docker 部署 (推荐)

```bash
# 克隆项目
git clone https://gitee.com/chenxiannn/codeflow.git
cd codeflow

# 配置环境变量
cp docker/.env.example docker/.env
# 编辑 docker/.env 设置必要的配置

# 启动服务
docker-compose -f docker/docker-compose.dev.yml up -d

# 查看日志
docker-compose -f docker/docker-compose.dev.yml logs -f
```

服务将在以下端口启动：
- 前端: http://localhost:5173
- 后端 API: http://localhost:8000
- API 文档: http://localhost:8000/docs
- PostgreSQL: localhost:5432
- Redis: localhost:6379

#### 方式二：本地开发

**1. 克隆项目**
```bash
git clone https://gitee.com/chenxiannn/codeflow.git
cd codeflow
```

**2. 后端设置**
```bash
cd backend

# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# 安装依赖
pip install -e ".[dev]"

# 配置环境变量
cp .env.example .env
# 编辑 .env 文件

# 初始化数据库
alembic upgrade head

# 启动后端
uvicorn app.main:app --reload
```

**3. 前端设置**
```bash
cd frontend

# 安装依赖
npm install

# 配置环境变量
cp .env.example .env
# 编辑 .env 文件

# 启动前端
npm run dev
```

**4. 访问应用**
- 前端: http://localhost:5173
- 后端: http://localhost:8000
- API 文档: http://localhost:8000/docs

---

## 📁 项目结构

```
codeflow/
├── backend/                    # 后端服务
│   ├── app/
│   │   ├── api/               # API 路由
│   │   │   └── v1/
│   │   │       └── endpoints/ # API 端点
│   │   ├── core/              # 核心配置
│   │   ├── db/                # 数据库
│   │   ├── models/            # SQLAlchemy 模型
│   │   ├── schemas/           # Pydantic 模式
│   │   ├── services/          # 业务逻辑
│   │   └── main.py            # 应用入口
│   ├── tests/                 # 测试
│   ├── alembic/               # 数据库迁移
│   ├── pyproject.toml        # Python 依赖
│   └── Dockerfile             # Docker 镜像
│
├── frontend/                   # 前端应用
│   ├── src/
│   │   ├── api/               # API 客户端
│   │   ├── assets/            # 静态资源
│   │   ├── components/        # Vue 组件
│   │   ├── router/            # 路由配置
│   │   ├── stores/            # Pinia 状态
│   │   ├── views/             # 页面视图
│   │   ├── App.vue            # 根组件
│   │   └── main.ts            # 入口文件
│   ├── package.json           # Node 依赖
│   └── Dockerfile             # Docker 镜像
│
├── docker/                     # Docker 配置
│   ├── docker-compose.yml     # 生产环境
│   ├── docker-compose.dev.yml # 开发环境
│   ├── nginx/                 # Nginx 配置
│   └── .env.example           # 环境变量模板
│
├── .claude/                    # Claude Code 配置
│   ├── agents/                # AI 审查代理
│   ├── plugins/               # 插件系统
│   ├── scripts/               # 自动化脚本
│   └── workflows/             # 工作流定义
│
├── mcp_servers/               # MCP 服务器
│   └── gitee_server.py       # Gitee 集成
│
├── docs/                       # 项目文档
│   ├── API.md                 # API 文档
│   ├── ARCHITECTURE.md        # 架构说明
│   ├── DEPLOYMENT.md          # 部署指南
│   └── CONTRIBUTING.md        # 贡献指南
│
└── README.md                  # 项目说明
```

---

## 🔧 配置说明

### 环境变量

#### 后端 (backend/.env)

```bash
# 应用配置
ENVIRONMENT=development
PROJECT_NAME=CodeFlow
VERSION=0.1.0

# 数据库
DATABASE_URL=postgresql+asyncpg://codeflow:password@localhost:5432/codeflow

# 安全
SECRET_KEY=your-secret-key-here
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRE_MINUTES=30

# AI 服务
ANTHROPIC_API_KEY=your_anthropic_api_key
ANTHROPIC_BASE_URL=https://open.bigmodel.cn/api/anthropic

# Redis (可选)
REDIS_URL=redis://:password@localhost:6379/0

# CORS
BACKEND_CORS_ORIGINS=http://localhost:5173,http://localhost:3000
```

#### 前端 (frontend/.env)

```bash
# API 地址
VITE_API_BASE_URL=http://localhost:8000/api/v1
```

---

## 🧪 测试

### 后端测试

```bash
cd backend

# 运行所有测试
pytest tests/

# 运行特定测试
pytest tests/test_api/test_users.py -v

# 查看测试覆盖率
pytest tests/ --cov=app --cov-report=html
```

### 前端测试

```bash
cd frontend

# 运行单元测试
npm run test

# 类型检查
npm run type-check

# 代码检查
npm run lint
```

---

## 📚 更多文档

- [API 文档](docs/API.md) - REST API 接口说明
- [架构说明](docs/ARCHITECTURE.md) - 系统架构详解
- [部署指南](docs/DEPLOYMENT.md) - 生产环境部署
- [贡献指南](docs/CONTRIBUTING.md) - 如何参与贡献

---

## 🤝 贡献指南

欢迎任何形式的贡献！

1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 创建 Pull Request

详细内容请查看 [贡献指南](docs/CONTRIBUTING.md)

---

## 📄 开源协议

本项目采用 [MIT](LICENSE) 协议开源。

---

## 🙏 致谢

感谢以下开源项目：

- [FastAPI](https://fastapi.tiangolo.com)
- [Vue.js](https://vuejs.org)
- [SQLAlchemy](https://www.sqlalchemy.org)
- [Anthropic Claude](https://www.anthropic.com)

---

## 📞 联系方式

- 项目主页: [https://gitee.com/chenxiannn/codeflow](https://gitee.com/chenxiannn/codeflow)
- 问题反馈: [Issues](https://gitee.com/chenxiannn/codeflow/issues)
- 邮箱: chenxiannn@example.com

---

<div align="center">

**⭐ 如果觉得有用，请点个 Star！**

Made with ❤️ by [CodeFlow Team](https://gitee.com/chenxiannn)

</div>