Flyx Claw Plugins Nexus

README

[中文](./README.md) | [English](./README.en.md)

# ⚡ OpenClaw Plugins ML

<div align="center">
  <img src="./assets/flyx-logo.png" alt="FlyX Claw Plugins Logo" width="220" />
</div>



<div align="center">

**CN / EN Bilingual · Flat + Futuristic · Multi-Plugin Monorepo**

![status](https://img.shields.io/badge/status-ready_for_release-2ea043?style=flat-square)
![lang](https://img.shields.io/badge/i18n-CN%20%2F%20EN-8957e5?style=flat-square)
![theme](https://img.shields.io/badge/ui-dark_tech-1f6feb?style=flat-square)
![license](https://img.shields.io/badge/license-MIT-238636?style=flat-square)

</div>

---

## 中文

一个面向长期扩展的 OpenClaw 多插件仓库，当前包含：

- **FlyX Todo**：任务管理 Web App（默认 `:3210`）
- **flyx-cron-dashboard**：定时任务状态看板（默认 `:3211`）

### 仓库结构

```text
openclaw_plugins_ml/
├─ README.md
├─ LICENSE
├─ .gitignore
├─ plugins/
│  ├─ flyx-todo/
│  ├─ flyx-cron-dashboard/
│  │  ├─ src/render_dashboard.py
│  │  └─ dist/index.html
│  └─ xxx-plugin/
├─ shared/
├─ scripts/
└─ docs/
```

### 快速启动

```bash
# FlyX Todo
cd /mnt/d/openclaw_ml/openclaw_plugins_ml/plugins/flyx-todo/taskboard_app
node server.mjs

# flyx-cron-dashboard 生成页面
python3 /mnt/d/openclaw_ml/openclaw_plugins_ml/plugins/flyx-cron-dashboard/src/render_dashboard.py
```

访问：
- FlyX Todo: `http://127.0.0.1:3210/`
- FlyX Cron Dashboard: `http://127.0.0.1:3211/`

---

## English

A scalable OpenClaw multi-plugin repository.

Current modules:
- **FlyX Todo**: task planner web app (`:3210`)
- **flyx-cron-dashboard**: FlyX cron health dashboard (`:3211`)

### Quick Start

```bash
# FlyX Todo
cd /mnt/d/openclaw_ml/openclaw_plugins_ml/plugins/flyx-todo/taskboard_app
node server.mjs

# flyx-cron-dashboard build
python3 /mnt/d/openclaw_ml/openclaw_plugins_ml/plugins/flyx-cron-dashboard/src/render_dashboard.py
```

---

## Release Docs

- `docs/I18N_POLICY.md`
- `docs/ROADMAP.md`
- `docs/RELEASE_CHECKLIST.md`
- `CHANGELOG.md`

## License

MIT

## Security Baseline / 安全基线

- Pre-commit secret scan enabled (`.git/hooks/pre-commit`)
- Repository-level quick secret scan completed before release
- No obvious secrets found by rule-based scan


## 面向用户的本地部署指南（Windows + WSL）

> 目标：让任何新用户在本地跑起来 FlyX Todo 与 flyx-cron-dashboard。

### 1) 环境准备

- Windows 10/11
- WSL2（Ubuntu 推荐）
- Node.js 18+（建议 20+）
- Python 3.10+
- Git

快速检查：

```bash
node -v
python3 --version
git --version
```

### 2) 获取项目
### 2.5) 一键让 OpenClaw 自动完成启动配置（推荐）

下载后在仓库根目录执行：

```bash
bash scripts/bootstrap_openclaw.sh
```

这条命令会自动完成：
- 启动 FlyX Todo（:3210）
- 生成并启动 Dashboard（:3211）
- 写入开机自启规则（`@reboot`）


```bash
git clone https://github.com/FlyXingByte/flyx-claw-plugins-nexus.git
cd flyx-claw-plugins-nexus
```

### 3) 启动 FlyX Todo（任务系统）

```bash
cd plugins/flyx-todo/taskboard_app
node server.mjs
```

打开浏览器访问：
- `http://127.0.0.1:3210/`
- 或 `http://<你的WSL-IP>:3210/`

健康检查：

```bash
curl http://127.0.0.1:3210/api/health
```

### 4) 生成并查看 flyx-cron-dashboard（定时任务看板）

```bash
cd /mnt/d/openclaw_ml/openclaw_plugins_ml
python3 plugins/flyx-cron-dashboard/src/render_dashboard.py
```

查看方式 A（本地文件）：
- `file:///D:/openclaw_ml/openclaw_plugins_ml/plugins/flyx-cron-dashboard/dist/index.html`

查看方式 B（本地服务）：

```bash
python3 -m http.server 3211 --bind 0.0.0.0 --directory plugins/flyx-cron-dashboard/dist
```

然后打开：
- `http://127.0.0.1:3211/`

### 5) 常见问题

- **3210 端口打不开**：确认 `node server.mjs` 进程仍在运行。  
- **页面不更新**：执行一次 `render_dashboard.py` 重新生成。  
- **中文/英文切换没生效**：浏览器强刷 `Ctrl+F5`。  
- **WSL 地址访问失败**：优先使用 `127.0.0.1` 测试。

### 6) 生产前建议

- 不要提交真实隐私数据到 `data.json`
- 使用 HTTPS / 反向代理（若局域网多人访问）
- 保留 pre-commit secret scan