# 🤖 天工智能体平台

> **Tiangong AI Agent Platform** — 一个支持可视化工作流设计和自主智能 Agent 配置的 AI 平台。

---

## 🚀 快速启动

```bash
# 使用 Docker Compose 一键启动（推荐）
docker-compose -f docker-compose.dev.yml up -d

# 访问地址
# 前端：http://localhost:8038
# API 文档：http://localhost:8037/docs
```

---

## 📚 文档中心

所有文档已统一整合至 **[`docs/` 目录](./docs/)**：

| 文档 | 说明 | 适用对象 |
|:-----|:------|:---------|
| [📖 快速开始指南](./docs/quickstart.md) | 5 分钟快速上手：安装、配置、启动 | 新用户、开发者 |
| [🏗️ 项目结构概览](./docs/project-structure.md) | 前端/后端目录结构与模块说明 | 开发者、维护者 |
| [🏛️ 架构设计文档](./docs/architecture.md) | 系统架构图、技术选型、数据流说明 | 架构师、高级开发者 |
| [🛠️ 开发指南](./docs/development-guide.md) | 编码规范、测试指南、调试技巧 | 开发者 |
| [🚀 部署与运维指南](./docs/deployment-guide.md) | 生产环境部署、配置说明、日常运维 | DevOps、运维 |
| [🔌 API 参考](./docs/api-reference.md) | RESTful API 端点说明与请求/响应格式 | 前端开发者、集成方 |
| [🤝 贡献指南](./docs/contributing.md) | 如何参与贡献、Code Review 流程 | 贡献者 |

---

## 🛠️ 技术栈

| 层级 | 技术 | 版本 |
|:----|:-----|:-----|
| 🖥 **前端** | Vue 3 + TypeScript + Vite + Pinia + Element Plus | 3.4+ |
| ⚙️ **后端** | Python FastAPI + SQLAlchemy + Pydantic + Celery | FastAPI 0.110+ |
| 🗄️ **数据库** | MySQL 8.0+（腾讯云） + Redis 7+ | — |
| 🤖 **AI 框架** | LangChain | 最新 |
| 🐳 **容器化** | Docker + Docker Compose | 最新 |

---

## 📁 项目结构

```
aiagent/
├── frontend/                 # 前端项目（Vue 3 + TypeScript）
│   ├── src/views/            # 页面组件
│   └── src/components/       # 公共组件
├── backend/                  # 后端项目（Python FastAPI）
│   ├── app/modules/          # 业务模块
│   ├── app/core/             # 核心功能
│   └── app/models/           # 数据模型
├── docs/                     # 📚 统一文档目录 ← 所有文档在此
│   ├── index.md              # 文档首页
│   ├── quickstart.md         # 快速开始
│   ├── project-structure.md  # 项目结构
│   ├── architecture.md       # 架构设计
│   ├── development-guide.md  # 开发指南
│   ├── deployment-guide.md   # 部署运维
│   ├── api-reference.md      # API 参考
│   └── contributing.md       # 贡献指南
├── docker-compose.dev.yml    # 开发环境 Docker 配置
├── nginx.conf                # Nginx 反向代理配置
└── README.md                 # 项目总览（本文档）
```

---

## 📝 开发规范

| 规范 | 工具 / 标准 |
|:-----|:------------|
| 前端代码 | ESLint + Prettier |
| 后端代码 | PEP 8 + Black + Flake8 |
| Git 提交 | [Conventional Commits](https://www.conventionalcommits.org/) |
| 代码审查 | 所有 PR 必须通过 Code Review |
| 测试 | 前端：Vitest / 后端：Pytest |

---

## 🧪 运行测试

```bash
# 前端测试
cd frontend
pnpm test

# 后端测试
cd backend
pytest --cov=app
```

---

## 📄 许可证

[MIT License](./LICENSE)

---

> 💡 **完整文档请见 [`docs/` 目录](./docs/)**