Freero

Freero

一款原创的实时协作白板：为团队提供无限画布，一起头脑风暴、规划、绘制图表和开展工作坊。

内容一览

• 画布 — 无限平移/缩放、点阵网格、缩略图、吸附和对齐参考线、多选、调整大小/旋转、分组、锁定、撤销/重做、跨白板复制/粘贴、拖放导入。
• 内容 — 便利贴、21 种形状、富文本、连接线（直线/折线/曲线，可附着并带标签）、画笔 + 荧光笔 + 橡皮擦、图片、表情符号和印章、画框、任务卡片、思维导图、标签、PDF、可在白板上播放的视频和音频，以及适用于其他任意文件的文件卡片。
• 协作 — 实时同步、光标和选区、头像、跟随协作者、“把所有人带到我这里”、表情回应、评论串、所有者/编辑者/评论者/查看者角色、通过邀请或链接分享。
• 引导 — 投票环节、共享计时器、在画框上进行演示。
• 模板与导出 — 18 个类别中的 180 个原创模板；导出为 PNG/JPG/SVG、将画框导出为 PDF、复制为图片。
• 仪表板 — 白板网格/列表、搜索、筛选、收藏、实时缩略图、复制、分享。

运行

需要 Node 22+。

npm install
npm run dev          # server on :4000 + web on :5173

打开 http://localhost:5173，使用预置的演示账号 [email protected] / freero123 登录（仅限开发环境），或注册账号。 http://localhost:5173/board/local 是无需服务端的离线沙盒白板。

生产环境：

npm run build && npm start     # serves the built web app and the marketing site (apps/site) on :4000
docker compose up --build -d   # or the full stack: proxy, 2 app replicas, Postgres, Redis, MinIO, Mailpit on :8080

实际部署：docs/deployment.md · 所有设置： docs/configuration.md · 备份、监控、事件处理： docs/operations.md。

配置：PORT（默认值为 4000）、FREERO_DATA_DIR（默认值为 ./data — 内置的 PGlite 数据库位于 data/pg，另含上传文件）、DATABASE_URL（改用实际的 Postgres）、DATABASE_POOL_MAX（默认值为 10）。如果你有迁移到 Postgres 之前的白板，请先停止开发服务器，然后运行一次 npm run db:import-sqlite。

开发

命令	功能
npm run check	架构边界 + 类型检查 + 单元测试
npm run verify	真实会话端到端检查：真实服务器、真实 Yjs WebSocket 客户端、角色、持久化
npm run new:feature <name> -- …	搭建功能文件夹的框架（参见 ARCHITECTURE.md）
node scripts/ui-shot.mjs --url … --out …	在无头 Chromium 中操作真实 UI 并截屏

Freero 遵循 Dune 方法： 功能位于彼此隔离的文件夹中，并通过保留文件名发现；每一项状态都只有一个写入者；违反依赖规则时，npm run check 会报错并指出受支持的路径。修改代码前请阅读 ARCHITECTURE.md。

技术栈：React 18 + TypeScript + Vite、基于 WebSocket 的 Yjs（CRDT）、Express + ws、PostgreSQL（pg；开发/测试使用 PGlite）、用于 UI 验证的 Playwright。

许可证

MIT。依赖项均采用宽松许可证（MIT、Apache-2.0、MPL-2.0）；GPL、AGPL 和仅开放源代码的项目仅在协议层集成，不会随项目一同打包。