Star-Office-UI

环境要求

• Python 3.10 及以上版本（不支持 3.9 及更低）
• 已安装 git，可克隆 GitHub 仓库
• 本地可监听 19000 端口用于访问看板
• 可选：已部署 OpenClaw，可获得自动状态同步的完整体验

安装与启动步骤

1. 1克隆仓库

   把 Star-Office-UI 源码下载到本地，并进入项目根目录，后续所有命令默认在此目录执行。

   git clone https://github.com/ringhyacinth/Star-Office-UI.git
   cd Star-Office-UI

   复制

2. 2安装依赖

   安装后端所需的 Python 依赖包，注意必须使用 Python 3.10+ 的 pip，否则可能装不上。

   python3 -m pip install -r backend/requirements.txt

   复制

3. 3准备状态文件

   首次部署需从示例文件复制一份 state.json，用来保存 AI 助手的当前状态与记录。

   cp state.sample.json state.json

   复制

4. 4启动后端

   进入 backend 目录启动 Flask 服务，启动后保持该终端窗口不要关闭。

   cd backend
   python3 app.py

   复制

5. 5验证部署

   在项目根目录另开终端运行冒烟测试，检查服务是否正常；所有检查显示 OK 即成功。

   python3 scripts/smoke_test.py --base-url http://127.0.0.1:19000

   复制

6. 6切换角色状态

   用脚本给角色切换状态（writing/error/idle 等），网页上看板会实时更新对应区域。

   python3 set_state.py writing "正在整理文档"

   复制

关键配置

如何确认成功

浏览器打开 http://127.0.0.1:19000 能看到像素办公室；或运行 python3 scripts/smoke_test.py --base-url http://127.0.0.1:19000，全部检查显示 OK。

常见问题

注意事项

• 代码采用 MIT 协议，但美术资源仅限非商业学习使用。
• 默认访问地址为 http://127.0.0.1:19000。
• 生产环境请复制 .env.example 为 .env，并设置强随机的 FLASK_SECRET_KEY 与 ASSET_DRAWER_PASS。
• OpenClaw 用户可直接把仓库中的 SKILL.md 链接发给龙虾，让其自动完成部署。