# ui-robot

**Repository Path**: qdyg/ui-robot

## Basic Information

- **Project Name**: ui-robot
- **Description**: No description available
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-03
- **Last Updated**: 2026-03-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Stop-Process -Name "python" -Force

# 自动化测试平台

<p align="center">
  <img src="https://img.shields.io/badge/Python-3.10+-blue.svg" alt="Python Version">
  <img src="https://img.shields.io/badge/FastAPI-0.104.1-green.svg" alt="FastAPI Version">
  <img src="https://img.shields.io/badge/Vue.js-3.5+-brightgreen.svg" alt="Vue Version">
  <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
</p>

一个集测试项目管理、测试用例设计、元素定位维护、测试执行调度、结果分析展示于一体的综合性UI自动化测试管理平台。

## 🌟 项目特色

- **全栈技术栈**: 基于FastAPI + Vue3的现代化前后端分离架构
- **智能化测试**: 支持多种元素定位方式和测试步骤编排
- **可视化管理**: 直观的项目管理和测试执行监控界面
- **安全可靠**: 完善的权限控制和数据安全保障
- **易于扩展**: 模块化设计，支持功能灵活扩展

## 🏗️ 技术架构

### 后端技术栈
- **框架**: FastAPI 0.104.1
- **数据库**: MySQL 8.0 + SQLAlchemy 2.0
- **缓存**: Redis 5.0+
- **认证**: JWT + OAuth2
- **部署**: Uvicorn ASGI服务器

### 前端技术栈
- **框架**: Vue 3.5 + TypeScript
- **UI库**: Element Plus 2.13
- **路由**: Vue Router 5.0
- **状态管理**: Pinia 3.0
- **构建工具**: Vite 7.3
- **图表**: ECharts 6.0

## 🚀 快速开始

### 环境要求

- **Python**: 3.10+
- **Node.js**: 20.19.0+ 或 22.12.0+
- **MySQL**: 8.0+
- **Redis**: 5.0+

### 项目初始化

```bash
# 克隆项目
git clone https://github.com/your-username/ui-robot.git
cd ui-robot

# 配置环境变量
cp .env.example .env
# 编辑 .env 文件，配置数据库、Redis等信息
```

### 后端启动

```bash
# 进入后端目录
cd backend

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

# 初始化数据库
python init_db.py

# 启动后端服务
uvicorn app.main:app --host 0.0.0.0 --port 8000 --env-file .env --reload
```

后端服务将在 `http://localhost:8000` 启动，API文档地址：
- Swagger UI: `http://localhost:8000/docs`
- ReDoc: `http://localhost:8000/redoc`

### 前端启动

```bash
# 进入前端目录
cd frontend

# 安装依赖
npm install

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

前端服务将在 `http://localhost:5173` 启动。

## 📁 项目结构

```
ui-robot/
├── backend/                 # 后端服务
│   ├── app/                # 应用核心代码
│   │   ├── api/           # API接口
│   │   ├── core/          # 核心配置
│   │   ├── models/        # 数据模型
│   │   ├── schemas/       # 数据验证
│   │   └── utils/         # 工具函数
│   ├── alembic/           # 数据库迁移
│   ├── sql/               # SQL脚本
│   └── storage/           # 存储目录
├── frontend/               # 前端应用
│   ├── src/               # 源代码
│   │   ├── api/          # API调用
│   │   ├── components/   # 组件
│   │   ├── views/        # 页面
│   │   ├── router/       # 路由配置
│   │   ├── stores/       # 状态管理
│   │   └── utils/        # 工具函数
│   └── public/            # 静态资源
├── document/              # 项目文档
│   ├── 产品需求文档_PRD.md
│   ├── 设计架构文档.md
│   ├── API接口文档.md
│   └── ...
├── .env.example           # 环境配置模板
└── README.md              # 项目说明
```

## 🔧 开发指南

### 代码规范

- **Python**: 遵循PEP 8规范
- **TypeScript**: 使用ESLint + Prettier
- **Vue**: 遵循Vue官方风格指南

### 数据库迁移

```bash
# 生成迁移脚本
cd backend
alembic revision --autogenerate -m "migration message"

# 执行迁移
alembic upgrade head
```

### API文档

项目使用OpenAPI 3.0规范，可通过以下方式访问：
- 交互式文档: `http://localhost:8000/docs`
- ReDoc文档: `http://localhost:8000/redoc`
- YAML定义: 查看 `document/openapi.yaml`

## 📊 功能特性

### 用户管理
- ✅ 用户注册/登录
- ✅ 权限控制
- ✅ 角色管理

### 项目管理
- ✅ 项目创建/编辑/删除
- ✅ 项目成员管理
- ✅ 项目状态跟踪

### 测试管理
- ✅ 模块化测试组织
- ✅ 元素定位管理
- ✅ 测试用例设计
- ✅ 测试步骤编排

### 执行监控
- ✅ 测试执行调度
- ✅ 实时执行状态
- ✅ 执行报告生成
- ✅ 结果可视化分析

## 🔒 安全特性

- JWT Token认证
- CSRF防护
- CORS配置
- 输入验证和过滤
- 密码加密存储
- 权限访问控制

## 🤝 贡献指南

欢迎提交Issue和Pull Request！

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

## 📝 文档资源

- [产品需求文档](./document/产品需求文档_PRD.md)
- [设计架构文档](./document/设计架构文档.md)
- [API接口文档](./document/API接口文档.md)
- [环境配置说明](./环境配置说明.md)

## 📄 许可证

本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。

## 📞 联系方式

如有问题或建议，请通过以下方式联系：

- 提交 [Issue](https://github.com/your-username/ui-robot/issues)
- 发送邮件至: your-email@example.com

---

<p align="center">Made with ❤️ for QA Engineers</p>