# codeguardian-ai

**Repository Path**: yun_long_wang/codeguardian-ai

## Basic Information

- **Project Name**: codeguardian-ai
- **Description**: 基于 AI 的智能代码审查平台，帮助开发团队自动发现代码中的 Bug、安全漏洞、性能问题与规范缺陷。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-16
- **Last Updated**: 2026-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java, Vue

## README

# CodeGuardian AI - 智能代码审查系统

基于 AI 的智能代码审查平台，帮助开发团队自动发现代码中的 Bug、安全漏洞、性能问题与规范缺陷。

## 技术栈

### 前端
- **框架**: Vue 3 + Vite
- **UI 组件库**: Ant Design Vue 4.x
- **状态管理**: Pinia
- **路由**: Vue Router 4
- **HTTP 客户端**: Axios
- **图表**: ECharts

### 后端
- **框架**: Spring Boot 3.x
- **ORM**: MyBatis Plus
- **安全**: Spring Security + JWT
- **AI 集成**: 通义千问 API / OpenAI API
- **数据库**: MySQL 8.0

## 快速开始

### 环境要求
- JDK 17+
- Node.js 18+
- MySQL 8.0
- Maven 3.8+

### 数据库初始化
```bash
# 创建数据库
mysql -u root -p -e "CREATE DATABASE codeguardian DEFAULT CHARACTER SET utf8mb4;"

# 执行初始化 SQL
mysql -u root -p codeguardian < backend/src/main/resources/sql/init.sql
```

### 启动后端
```bash
cd backend
mvn clean package -DskipTests
java -jar target/codeguardian-ai.jar
```

### 启动前端
```bash
cd frontend
npm install
npm run dev
```

### 配置 AI API
在系统设置中配置通义千问或 OpenAI 的 API Key 和 Base URL 后即可使用 AI 审查功能。

## 项目结构
```
codeguardian-ai/
├── frontend/                # Vue 3 前端项目
│   ├── src/
│   │   ├── views/          # 页面组件
│   │   ├── components/     # 公共组件
│   │   ├── store/          # Pinia 状态管理
│   │   ├── router/         # 路由配置
│   │   ├── api/            # API 请求层
│   │   ├── assets/         # 静态资源
│   │   └── utils/          # 工具函数
│   └── package.json
├── backend/                 # Spring Boot 后端项目
│   └── src/main/
│       ├── java/com/codeguardian/
│       │   ├── controller/  # 控制器
│       │   ├── service/     # 服务层
│       │   ├── mapper/      # MyBatis 映射
│       │   ├── entity/      # 实体类
│       │   ├── dto/         # 数据传输对象
│       │   ├── config/      # 配置类
│       │   ├── security/    # 安全配置
│       │   └── utils/       # 工具类
│       └── resources/
│           ├── sql/         # SQL 脚本
│           └── mapper/      # XML 映射文件
└── README.md
```

## 核心功能
- 用户认证与权限管理（JWT）
- 代码仓库管理（GitHub/GitLab）
- PR/MR 自动监听与导入
- AI 智能代码审查（Bug检测、安全扫描、性能优化、代码规范）
- 审查报告展示（行级标注）
- 统计仪表盘与趋势图表
- 通知中心
- 系统设置

## License
MIT