文档翻译智能体——Agent 是大脑,程序是手脚。用户上传英文文献 PDF,获得"像原文档的中文版":翻译、结构保留排版、质检一条龙。
目标:仓库、后端、前端、数据库可启动。
验收标准:未参与搭建的队友,从 git clone 全新仓库开始,按本 README 操作,十分钟内跑起来看到首页(阶段 0 验收测试员:邹州,兼任)。
docwise-web/
├── backend/ # FastAPI 后端(Python)
├── frontend/ # Vue3 + Naive UI 前端(由前端负责人创建)
└── README.md
前置:安装 uv(Python 包与环境管理器)。Windows 可用 pip install uv,或按官网说明安装。
cd backend
uv sync # 自动创建 .venv 并安装依赖(首次需联网,几分钟)
uv run uvicorn app.main:app --port 8000启动后验证:
- 打开 http://127.0.0.1:8000/api/health ,返回
{"status":"ok",...}即后端正常。 - 打开 http://127.0.0.1:8000/api/tasks ,返回任务列表(初始为空数组)。
- 数据库为 SQLite,首次启动自动建表,文件在
backend/data/docwise.db(不提交仓库)。
可选配置:复制 backend/.env.example 为 backend/.env,可修改数据库路径(.env 不提交仓库)。
前置:安装 bun(JS/TS 包与环境管理器,自带运行时,无需单独安装
Node.js)。Windows 可执行 powershell -c "irm bun.sh/install.ps1 | iex",或按官网说明安装。
cd frontend
bun install # 首次需联网安装依赖
bun dev # 启动开发服务器注意:不要直接双击
frontend/index.html打开(会白屏),必须通过bun dev启动后访问 http://localhost:5173 。
启动后验证:
- 打开 http://127.0.0.1:5173 ,看到「文档翻译智能体」首页(产品介绍 + PDF 上传入口占位)。
- 先启动后端时,首页底部显示「后端状态:已连接」及任务数量;未启动则显示未连接。
- 前端
/api由 Vite 代理到 http://127.0.0.1:8000(后端),无需额外 CORS 配置。
git clone本仓库(全新克隆,不用旧环境)。- 严格按"后端启动"与"前端启动"两节操作,全程计时。
- 十分钟内看到前端首页,且后端健康检查通过,即验收通过。
- 验收记录(截图 + 步骤 + 卡点)提交到仓库或群里。
- API key 等密钥一律进本地
.env,绝不提交仓库。 - 提交信息使用 Conventional Commits:
feat(scope): message。 - 数据库访问统一走 SQLAlchemy ORM,将来换 PostgreSQL 只改配置。