Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docwise-web

文档翻译智能体——Agent 是大脑,程序是手脚。用户上传英文文献 PDF,获得"像原文档的中文版":翻译、结构保留排版、质检一条龙。

阶段 0(2026-08-04 启动,DDL:2026-08-07)

目标:仓库、后端、前端、数据库可启动。

验收标准:未参与搭建的队友,从 git clone 全新仓库开始,按本 README 操作,十分钟内跑起来看到首页(阶段 0 验收测试员:邹州,兼任)。

目录结构

docwise-web/
├── backend/    # FastAPI 后端(Python)
├── frontend/   # Vue3 + Naive UI 前端(由前端负责人创建)
└── README.md

后端启动(约 3 分钟)

前置:安装 uv(Python 包与环境管理器)。Windows 可用 pip install uv,或按官网说明安装。

cd backend
uv sync        # 自动创建 .venv 并安装依赖(首次需联网,几分钟)
uv run uvicorn app.main:app --port 8000

启动后验证:

可选配置:复制 backend/.env.examplebackend/.env,可修改数据库路径(.env 不提交仓库)。

前端启动(约 2 分钟)

前置:安装 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

启动后验证:

阶段 0 验收方式

  1. git clone 本仓库(全新克隆,不用旧环境)。
  2. 严格按"后端启动"与"前端启动"两节操作,全程计时。
  3. 十分钟内看到前端首页,且后端健康检查通过,即验收通过。
  4. 验收记录(截图 + 步骤 + 卡点)提交到仓库或群里。

约定

  • API key 等密钥一律进本地 .env绝不提交仓库
  • 提交信息使用 Conventional Commits:feat(scope): message
  • 数据库访问统一走 SQLAlchemy ORM,将来换 PostgreSQL 只改配置。

About

docwise-web:文档翻译智能体(Agent 是大脑,程序是手脚)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages