Skip to content

README.zh-CN.md

Latest commit

 

History

History
60 lines (45 loc) · 2.66 KB

README.zh-CN.md

File metadata and controls

60 lines (45 loc) · 2.66 KB
Raw

Univer Collaboration SDK

English | 简体中文

本仓库只保存 Univer Collaboration SDK 的可运行示例。公开文档统一维护在 office.univer.ai。

从这里开始

  1. 按文档站的快速开始，用两个浏览器 确认 HTTP、WebSocket 和 OT 主链路。
  2. 从下方选择想了解的功能示例，对照最小的前后端源码。
  3. 架构、middleware、身份、持久化和生产运行说明统一查阅 协同编辑文档。

选择示例

所有示例使用相同的 web/main.ts + server/main.ts 最小结构，并且可以独立运行。建议先从 quick-start 建立协同主链路，再根据想了解的功能选择其他示例。

示例 内容
quick-start 最小 Sheet 实时协同链路
database-adapter SQLite 持久化与重启恢复
permissions 可信身份与服务端权限边界
history 版本历史服务与浏览器入口
comments Thread Comment 服务与前端入口
worktree draft、ready、reopen 和 merge 的完整生命周期
exchange 基于 exchange-node 的 Sheet 服务端导入导出

运行示例

准备 Node.js 24 及以上版本和 pnpm：

pnpm install
pnpm example:quick-start

其他示例使用同样的命令形式：

pnpm example:database-adapter
pnpm example:permissions
pnpm example:history
pnpm example:comments
pnpm example:worktree
pnpm example:exchange

示例只承担教学和可复制装配，不包含文件空间、多类型产品编辑器或完整办公套件。exchange 示例 特意使用内存文件与任务存储，不代替生产文件服务。

quick-start 为保持最短装配刻意保留 Memory Adapter；其他示例都把协同数据写入各自的 .data/collaboration.sqlite，服务重启后仍会保留。

固定用户、演示授权和本地密钥仅用于教学，不是生产配置。生产接入前请阅读 身份与权限、 Middleware 与 Event和 Database Adapter。