# CodeGenius

**Repository Path**: fy_group/code-genius

## Basic Information

- **Project Name**: CodeGenius
- **Description**: CodeGenius：专注于代码生成与优化的开源团队，提供自动化工具与算法，帮助开发者提高效率，简化复杂编程任务。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2026-03-15
- **Last Updated**: 2026-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# CodeGenius

CodeGenius 是一款强大的 AI 辅助编程桌面应用程序，基于 DeepSeek 大语言模型，为开发者提供代码生成、优化、审查、重构等功能。

## 功能特性

### 代码生成
根据需求描述自动生成代码，支持多种编程语言。

### 代码优化
分析现有代码，提供性能优化建议和改进方案。

### 代码审查
自动审查代码质量，发现潜在问题并提供修复建议。

### 代码重构
智能重构代码，改善代码结构和可维护性。

### API 文档生成
自动生成 API 文档，支持多种框架。

### 架构文档生成
根据组件和关系自动生成架构文档。

### 代码注释生成
为代码自动生成规范的注释文档。

### 智能对话
内置 AI 助手，可以进行编程相关的智能对话。

## 技术架构

### 后端
- **FastAPI**: 高性能 Python Web 框架
- **DeepSeek AI**: 强大的代码理解与生成能力
- **Redis**: 会话缓存支持
- **Rate Limiter**: API 速率限制

### 前端
- **Electron**: 跨平台桌面应用框架
- **原生 UI**: 流畅的桌面应用体验

## 快速开始

### 环境要求

- Node.js 18+
- Python 3.8+
- DeepSeek API Key

### 安装部署

#### Windows

```bash
# 克隆项目
git clone https://gitee.com/fy_group/code-genius.git
cd code-genius

# 启动前后端
start.bat
```

#### Linux / macOS

```bash
# 克隆项目
git clone https://gitee.com/fy_group/code-genius.git
cd code-genius

# 启动前后端
chmod +x start.sh
./start.sh
```

### 手动启动

#### 1. 启动后端

```bash
cd backend

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

# 安装依赖
pip install -r requirements.txt

# 复制配置示例
cp .env.example .env

# 编辑 .env 文件，配置 DeepSeek API Key
# DEEPSEEK_API_KEY=your_api_key_here

# 启动后端服务
python -m uvicorn app.main:app --reload
```

后端服务默认运行在 `http://localhost:8000`

#### 2. 启动前端

```bash
cd frontend

# 安装依赖
npm install
# 或 pnpm install

# 启动开发服务
npm run dev
```

前端应用默认运行在 `http://localhost:5173`

## 配置说明

### 后端配置 (.env)

| 配置项 | 说明 | 默认值 |
|--------|------|--------|
| DEEPSEEK_API_KEY | DeepSeek API 密钥 | - |
| DEEPSEEK_BASE_URL | API 基础地址 | https://api.deepseek.com |
| REDIS_URL | Redis 连接地址 | redis://localhost:6379 |
| SECRET_KEY | 应用密钥 | 自动生成 |

### 速率限制

- 每分钟请求数：60
- 每小时请求数：1000

## API 文档

启动后端服务后，可访问以下地址查看完整 API 文档：

- Swagger UI: `http://localhost:8000/docs`
- ReDoc: `http://localhost:8000/redoc`

## 核心模块

### 后端模块

```
backend/
├── app/
│   ├── api/          # API 路由
│   │   ├── chat.py   # 对话接口
│   │   ├── code.py   # 代码相关接口
│   │   └── docs.py   # 文档生成接口
│   ├── clients/      # 外部客户端
│   │   └── deepseek_client.py
│   ├── models/       # 数据模型
│   ├── services/     # 业务逻辑
│   └── utils/        # 工具函数
└── scripts/          # 脚本工具
```

### 前端模块

```
frontend/
├── src/
│   ├── main/         # Electron 主进程
│   └── renderer/     # 渲染进程
│       ├── css/      # 样式文件
│       ├── js/       # JavaScript 逻辑
│       └── index.html
```

## 使用指南

### 首次使用

1. 启动应用程序
2. 在设置中配置 DeepSeek API Key
3. 测试连接确保配置正确

### 主要功能操作

- **代码生成**: 输入需求描述，选择语言，生成代码
- **代码优化**: 粘贴代码，设置优化目标，获取优化建议
- **代码审查**: 提交代码，获取问题分析和修复建议
- **智能对话**: 与 AI 助手进行编程相关交流

## 贡献指南

欢迎提交 Issue 和 Pull Request！

## 许可证

MIT License

## 联系方式

如有问题，请提交 Issue 或联系开发团队。