commit 685d69ebdc772e7cc15c37d71bd8f1a23acecc17 Author: zwt13703 Date: Wed Jul 1 19:50:29 2026 +0800 init project diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..803c13c --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +# Default ignored files +.idea +.idea/** +node_modules diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..2615cf5 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,160 @@ +# AGENTS.md — AI 编码助手指引 + +> 本文档供 Claude Code / Copilot / Cursor 等 AI 编码助手读取,确保生成的代码符合项目约定。 + +--- + +## 项目概述 + +AI 文档模板生成系统(第一阶段 MVP),定位是一个 **Word 模板标注器**。 + +核心流程:上传 Word → 解析标题/段落/表格 → 生成 HTML 预览(含 data-block-id)→ 用户点击区域 → 配置提示词 → 保存配置。 + +--- + +## 技术栈 + +- **前端**:Vue 3 + TypeScript + Vite + Element Plus + Pinia + Vue Router 4 +- **后端**:Python 3.11+ + FastAPI + SQLAlchemy + Alembic + MySQL 8.0 +- **存储**:MinIO(文件)/ MySQL(结构化数据) +- **关键词**:block_id, template, region_type, upsert + +--- + +## 代码约定 + +### 后端 + +- 路由文件在 `app/api/`,服务逻辑在 `app/services/`,Model 在 `app/models/` +- 所有接口返回 JSON,统一格式 `{"data": ..., "message": "ok"}` +- 错误返回 `{"detail": "错误信息"}` +- 使用 Python类型注解 +- 数据库 session 通过依赖注入 `get_db` 获取 +- Model 使用 `sqlalchemy.orm.DeclarativeBase` + +### 前端 + +- 组件使用 Composition API + `