init

2026-06-06 23:54:11 +08:00
commit 33639129b1
58 changed files with 10309 additions and 0 deletions
@@ -0,0 +1,59 @@
+# 交互式透明化宿舍报修系统
+
+课程项目 —— 带 AI 诊断引导的宿舍报修流程。
+
+## 快速开始
+
+```bash
+./cli.py setup           # 安装依赖
+./cli.py env             # 创建 .env（可选，未配置 DeepSeek 则使用关键词诊断）
+./cli.py start           # 启动前后端
+```
+
+## 常用命令
+
+```bash
+./cli.py start           # 启动服务
+./cli.py stop            # 停止服务
+./cli.py status          # 查看状态
+./cli.py logs backend -f # 实时日志
+./cli.py seed            # 写入演示数据
+./cli.py docker up       # Docker 部署
+```
+
+## 服务地址
+
+| 服务 | 地址 |
+| --- | ---- |
+| 前端 | <http://127.0.0.1:5173> |
+| 后端 API | <http://127.0.0.1:8000> |
+| API 文档 | <http://127.0.0.1:8000/docs> |
+
+## 演示账号
+
+运行 `./cli.py seed` 写入演示数据：
+
+| 角色 | 用户名 | 密码 |
+|------|--------|------|
+| 学生 | `student01` | `Student123` |
+| 管理员 | `admin01` | `Admin123` |
+
+## 环境变量
+
+`./cli.py env` 会从 `.env.example` 复制模板。主要配置项见 `backend/.env.example`。
+
+关键变量：`DEEPSEEK_API_KEY` — 配置后启用 AI 诊断，留空则降级为关键词匹配。
+
+## 主流程
+
+1. 学生用自然语言描述故障 → AI/关键词诊断追问 → 生成结构化草稿 → 确认提交
+2. 管理员审核工单、分配人员、更新状态
+3. 学生确认完工并评价
+
+## 技术栈
+
+```
+后端  FastAPI + SQLite + DeepSeek API
+前端  Vue 3 + Element Plus + Vite
+管理  ./cli.py 统一入口 | Docker Compose 可选
+```