EditMason

像 Notion/Obsidian 一样顺滑的 DOCX / PDF（以及 Canvas）编辑体验原型。

项目结构

EditMason/
├── frontend/          # React + Vite 前端
├── backend/           # Flask + SQLite 后端
└── docs/              # 文档

快速开始

1. 启动后端

cd backend

# 安装依赖
pip install -r requirements.txt

# 初始化数据库（可选，会创建示例数据）
python seed.py

# 启动服务
python run.py

后端服务运行在 http://localhost:5000

2. 启动前端

cd frontend

# 安装依赖
npm install

# 启动开发服务器
npm run dev

前端服务运行在 http://localhost:5173

3. 配置说明

使用真实后端

在 frontend/.env 中配置：

VITE_USE_MOCKS=false
VITE_API_BASE=http://localhost:5000/api

使用 Mock API（开发调试）

VITE_USE_MOCKS=true
VITE_API_BASE=/api

API 端点

方法	端点	描述
GET	/api/health	健康检查
GET	/api/projects	获取项目列表
POST	/api/projects	创建项目
POST	/api/projects/:id/docs	创建文档
POST	/api/projects/:id/files	上传文件
GET	/api/docs/:id	获取文档
PUT	/api/docs/:id	更新文档
POST	/api/docs/:id/export	导出文档
POST	/api/docs/:id/ocr	OCR 识别
GET	/api/jobs/:id	获取任务状态

详细 API 文档请参阅 docs/API-Documentation.md

技术栈

前端

• React 18
• TypeScript
• Vite
• Tiptap (富文本编辑器)
• Zustand (状态管理)
• React Router

后端

• Python 3.11+
• Flask 3.x
• SQLAlchemy
• SQLite

文档

• API 文档 - 完整的 API 接口说明
• 测试报告 - 测试结果和性能指标
• 产品说明 - 产品设计文档
• 前端 API 状态 - 前端接口对接状态

功能特性

• ✅ Obsidian 风格的实时预览编辑
• ✅ Markdown 快捷输入
• ✅ 浮动格式工具栏
• ✅ 项目和文档管理
• ✅ 自动保存
• ✅ PDF 查看和注释
• ✅ Canvas 画布编辑
• 🚧 文档导出（开发中）
• 🚧 OCR 识别（开发中）

开发

后端开发

cd backend
python run.py  # 启动开发服务器（自动重载）

前端开发

cd frontend
npm run dev    # 启动开发服务器
npm run build  # 构建生产版本
npm run lint   # 代码检查

License

MIT