docs(readme): add env and smoke test hints

Made-with: Cursor
This commit is contained in:
RoomWithOutRoof committed 2026-03-06 02:04:10 +08:00
1 parent 8d36ad5267
commit 0a93306958
3 files changed
+36

No files matched your search

+12
View File
@@ -79,6 +79,8 @@ python3 app.py
Open `http://127.0.0.1:18791`
> ✅ For local development you can start with the defaults; in production, copy `.env.example` to `.env` and set strong random values for `FLASK_SECRET_KEY` and `ASSET_DRAWER_PASS` to avoid weak passwords and session leaks.
### 4) Switch states
```bash
@@ -96,6 +98,16 @@ cloudflared tunnel --url http://127.0.0.1:18791
Share the `https://xxx.trycloudflare.com` link with anyone.
### 6) Verify your installation (optional)
While the backend is running, you can run a lightweight smoke test to confirm that the core endpoints are healthy:
```bash
python3 scripts/smoke_test.py --base-url http://127.0.0.1:18791
```
If all checks report `OK`, your Star Office UI service is wired up correctly for basic status flows.
---
## 🦞 For OpenClaw Users
+12
View File
@@ -30,6 +30,8 @@ python3 app.py
**http://127.0.0.1:18791** を開き、状態を切り替えてみましょう:
> ✅ ローカル開発ではデフォルト設定のままで構いませんが、本番環境では `.env.example` を `.env` にコピーし、`FLASK_SECRET_KEY` と `ASSET_DRAWER_PASS` に十分な長さのランダム値を設定することをおすすめします(弱いパスワードやセッション漏洩を防ぐため)。
```bash
python3 set_state.py writing "ドキュメント整理中"
python3 set_state.py error "問題を検出、調査中"
@@ -40,6 +42,16 @@ python3 set_state.py idle "待機中"
---
## ✅ インストール確認(任意)
バックエンドが起動している状態で、簡単な smoke test を実行して主要エンドポイントが正常かどうかを確認できます:
```bash
python3 scripts/smoke_test.py --base-url http://127.0.0.1:18791
```
すべてのチェックが `OK` と表示されれば、Star Office UI の基本的なステータスフローが正しく動作していることを意味します。
## 📋 機能一覧
1. **ステータス可視化** —— 6 種類の状態(`idle` / `writing` / `researching` / `executing` / `syncing` / `error`)がオフィスの各エリアに自動マッピングされ、アニメーションと吹き出しでリアルタイム表示
+12
View File
@@ -79,6 +79,8 @@ python3 app.py
打开 `http://127.0.0.1:18791`
> ✅ 如果你是首次部署,可以先保留默认的开发配置;在生产环境中,请复制 `.env.example` 为 `.env` 并设置强随机的 `FLASK_SECRET_KEY` 与 `ASSET_DRAWER_PASS`,避免弱密码和会话泄露。
### 4) 切换状态
```bash
@@ -96,6 +98,16 @@ cloudflared tunnel --url http://127.0.0.1:18791
拿到 `https://xxx.trycloudflare.com` 链接即可分享。
### 6) 验证安装(可选)
在后端运行中时,可以执行一次轻量级的 smoke test,确认核心接口是否正常工作:
```bash
python3 scripts/smoke_test.py --base-url http://127.0.0.1:18791
```
如果所有检查都显示 `OK`,说明后端路由和基础状态流转已经就绪。
---
## 🦞 给 OpenClaw 用户