docs: update README with web features, remove dev planning docs
- Add Web 端功能 section covering all features - Add web/ directory to project structure - Add Web startup instructions (backend + frontend) - Remove docs/superpowers/ (internal dev planning docs) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -15,6 +15,8 @@
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 桌面端 (GUI / CLI)
|
||||
|
||||
```bash
|
||||
# 安装依赖
|
||||
pip install -r requirements.txt
|
||||
@@ -30,6 +32,31 @@ python headless_api.py data/input/xxx.jpg --barcode 6920584471055 --target 69205
|
||||
python build_exe.py
|
||||
```
|
||||
|
||||
### Web 端
|
||||
|
||||
```bash
|
||||
# 后端依赖
|
||||
cd web/backend && pip install -r requirements.txt
|
||||
|
||||
# 前端依赖
|
||||
cd web/frontend && npm install
|
||||
|
||||
# 启动后端 (端口 8000)
|
||||
cd web && python -m uvicorn backend.main:app --host 0.0.0.0 --port 8000 --reload
|
||||
|
||||
# 启动前端开发服务器 (端口 5173)
|
||||
cd web/frontend && npm run dev
|
||||
|
||||
# 构建前端到后端静态目录
|
||||
cd web/frontend && npm run build
|
||||
# 构建后直接访问 http://localhost:8000 即可
|
||||
|
||||
# 生产部署 (仅后端,前端已内嵌)
|
||||
cd web && python -m uvicorn backend.main:app --host 0.0.0.0 --port 8000
|
||||
```
|
||||
|
||||
**默认账号:** `admin` / `admin123`(首次登录后建议修改密码)
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
@@ -50,16 +77,85 @@ python build_exe.py
|
||||
│ │ └── utils/ # 工具(日志、文件、字符串、云端同步、对话框)
|
||||
│ ├── services/ # 业务服务(订单、OCR、处理器调度)
|
||||
│ └── ui/ # GUI 模块(主题、日志、快捷键、主窗口)
|
||||
├── web/ # Web 端
|
||||
│ ├── backend/
|
||||
│ │ ├── main.py # FastAPI 入口
|
||||
│ │ ├── auth/ # JWT 认证(登录、Token、权限)
|
||||
│ │ ├── routers/ # API 路由(文件、处理、记忆、条码、同步、任务、日志)
|
||||
│ │ ├── services/ # 后端服务(任务管理、数据库、文件同步)
|
||||
│ │ └── middleware/ # HTTP 日志中间件
|
||||
│ └── frontend/
|
||||
│ ├── src/
|
||||
│ │ ├── views/ # 页面(Dashboard、Layout、文件管理、任务、日志等)
|
||||
│ │ ├── stores/ # Pinia 状态管理(auth、processing)
|
||||
│ │ ├── composables/ # 共享逻辑(useDebounce、useFileUtils、useFilePreview)
|
||||
│ │ ├── api.ts # Axios 封装
|
||||
│ │ └── router/ # Vue Router 路由
|
||||
│ ├── package.json
|
||||
│ └── vite.config.ts
|
||||
├── templates/
|
||||
│ ├── 银豹-采购单模板.xls # 输出模板(条码/采购量/赠送量/单价)
|
||||
│ └── 商品资料.xlsx # 单价校验参考数据
|
||||
├── data/
|
||||
│ ├── input/ # 输入文件
|
||||
│ ├── output/ # OCR 输出
|
||||
│ └── result/ # 最终采购单
|
||||
│ ├── result/ # 最终采购单
|
||||
│ └── web_data.db # Web 端数据库(SQLite)
|
||||
└── tests/ # 单元测试(191 个)
|
||||
```
|
||||
|
||||
## Web 端功能
|
||||
|
||||
基于 Vue 3 + Element Plus + FastAPI 的浏览器端管理界面,与桌面端共享同一个 `data/` 目录。
|
||||
|
||||
### 处理中心 (Dashboard)
|
||||
|
||||
- **一键全流程**:上传图片或 Excel 后,一键完成 OCR → 标准化 → 合并全流程
|
||||
- **批量 OCR / 批量处理**:可单独执行 OCR 识别或 Excel 标准化步骤
|
||||
- **实时进度**:WebSocket 推送任务进度、日志、状态变更
|
||||
- **多任务监控**:同时查看多个运行中任务的进度和日志
|
||||
- **任务重试**:失败任务可查看错误详情并一键重试
|
||||
|
||||
### 文件管理
|
||||
|
||||
- **图片处理**:管理 `data/input/` 中的图片文件,支持上传、预览、批量 OCR、批量生成采购单
|
||||
- **表格处理**:管理 `data/output/` 中的 Excel 文件,支持上传、预览、批量标准化处理
|
||||
- **采购单管理**:管理 `data/result/` 中的采购单,支持预览、下载、合并、批量删除
|
||||
- **实时同步**:页面加载时自动同步磁盘文件到数据库,新文件立即可见
|
||||
- **清除处理缓存**:删除已处理的输出文件,允许重新处理
|
||||
|
||||
### 任务与日志
|
||||
|
||||
- **任务历史**:查看所有处理任务的状态、进度、日志,支持按状态和类型筛选
|
||||
- **HTTP 日志**:记录所有 API 请求,支持按方法和状态码筛选
|
||||
|
||||
### 记忆库
|
||||
|
||||
- **产品记忆**:自动从 OCR 和处理结果中学习产品信息
|
||||
- **置信度系统**:根据出现次数自动评估记忆可靠度
|
||||
- **搜索与管理**:支持搜索、编辑、删除记忆条目
|
||||
|
||||
### 条码映射
|
||||
|
||||
- **映射规则管理**:添加、编辑、删除条码转换规则
|
||||
- **批量操作**:支持批量导入和删除映射
|
||||
|
||||
### 云端同步
|
||||
|
||||
- **Gitea 同步**:通过 Gitea REST API 在多台设备间同步配置文件
|
||||
- **一键推拉**:选择文件推送或拉取,无需 git 客户端
|
||||
|
||||
### 系统配置
|
||||
|
||||
- **配置编辑**:在浏览器中编辑系统配置(API 密钥、路径、参数)
|
||||
- **修改密码**:支持修改 Web 端登录密码
|
||||
|
||||
### UI/UX
|
||||
|
||||
- **响应式布局**:适配桌面和移动端,小屏幕自动切换为抽屉式导航
|
||||
- **全局错误处理**:未捕获的 Vue 错误自动显示用户提示
|
||||
- **表单验证**:修改密码等操作有完整的输入验证
|
||||
|
||||
## 供应商智能路由
|
||||
|
||||
| 供应商 | 识别特征 | 处理逻辑 |
|
||||
|
||||
Reference in New Issue
Block a user