2025-04-24 19:13:20 +08:00
|
|
|
|
# CS Auto Report
|
2025-04-24 19:10:28 +08:00
|
|
|
|
|
2025-04-24 19:13:20 +08:00
|
|
|
|
基于Tauri + React + TypeScript的自动化报告生成工具
|
2025-04-24 19:10:28 +08:00
|
|
|
|
|
2025-04-24 19:13:20 +08:00
|
|
|
|
## 项目概述
|
2025-04-24 19:10:28 +08:00
|
|
|
|
|
2025-04-24 19:13:20 +08:00
|
|
|
|
本工具旨在帮助开发团队自动化生成代码提交报告,支持从Git仓库提取提交历史并生成可视化报告。
|
|
|
|
|
|
|
|
|
|
|
|
## 主要功能
|
|
|
|
|
|
|
|
|
|
|
|
- 多Git仓库管理
|
|
|
|
|
|
- 提交历史可视化
|
|
|
|
|
|
- 自定义报告模板
|
|
|
|
|
|
- 自动化报告生成
|
|
|
|
|
|
- 本地数据存储
|
|
|
|
|
|
|
|
|
|
|
|
## 技术栈
|
|
|
|
|
|
|
|
|
|
|
|
- **框架**: Tauri + React
|
|
|
|
|
|
- **构建工具**: Vite + Bun
|
|
|
|
|
|
- **UI组件**: Ant Design + TailwindCSS
|
|
|
|
|
|
- **编程语言**: TypeScript
|
|
|
|
|
|
- **代码质量**: Biome
|
|
|
|
|
|
|
|
|
|
|
|
## 快速开始
|
|
|
|
|
|
|
|
|
|
|
|
### 安装依赖
|
|
|
|
|
|
```bash
|
|
|
|
|
|
bun install
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### 开发模式
|
|
|
|
|
|
```bash
|
|
|
|
|
|
bun run dev
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### 构建应用
|
|
|
|
|
|
```bash
|
|
|
|
|
|
bun run build
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 开发指南
|
|
|
|
|
|
|
|
|
|
|
|
### 推荐IDE
|
|
|
|
|
|
|
|
|
|
|
|
- [VS Code](https://code.visualstudio.com/) +
|
|
|
|
|
|
- [Tauri插件](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) +
|
|
|
|
|
|
- [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
|
|
|
|
|
|
|
|
|
|
|
|
### 项目结构
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
├── src/
|
|
|
|
|
|
│ ├── components/ # React组件
|
|
|
|
|
|
│ ├── pages/ # 页面组件
|
|
|
|
|
|
│ └── ...
|
|
|
|
|
|
├── src-tauri/ # Tauri后端代码
|
|
|
|
|
|
└── ...
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 贡献指南
|
|
|
|
|
|
|
|
|
|
|
|
欢迎提交Pull Request,请确保代码符合Biome规范。
|