Final update: Complete README and project structure

- Comprehensive README with badges and documentation - API endpoint documentation - Project structure overview - Development log
2026-04-01 20:52:24 +08:00
parent 4be901b1b0
commit 8d0a2ccb0b
1 changed files with 153 additions and 29 deletions
--- a/README.md
+++ b/README.md
@@ -1,54 +1,178 @@
-# 龙虾舰队监控中心
+# 🦞 龙虾舰队监控中心

-> 基于 React + Django 的龙虾状态监控系统
+> 基于 React + Django 的实时监控系统
+
+[![Git 仓库](https://img.shields.io/badge/git-repository-blue)](https://xjp.datalibstar.com/flying-hero/openclaw-monitor.git)
+[![版本](https://img.shields.io/badge/version-1.0.0-green)](https://xjp.datalibstar.com/flying-hero/openclaw-monitor.git)
+
+---
+
+## 📋 项目简介
+
+龙虾舰队监控中心是一个实时监控多只 OpenClaw 龙虾运行状态的系统，提供：
+- 📊 实时状态监控
+- 🧠 记忆日历查看
+- 🔍 全文检索
+- 🛠️ 工具管理
+
+---

 ## 🚀 快速开始

-### 前端
+### 1. 克隆项目
 ```bash
-cd code/frontend
-npm install
-npm start
+git clone https://xjp.datalibstar.com/flying-hero/openclaw-monitor.git
+cd monitoring-website
 ```

-### 后端
+### 2. 安装依赖
 ```bash
+# 后端
 cd code/backend
-python manage.py runserver
+pip3 install -r requirements.txt
+
+# 前端
+cd ../frontend
+npm install
 ```

+### 3. 启动服务
+```bash
+# 使用启动脚本
+chmod +x start.sh
+./start.sh
+
+# 或手动启动
+# 后端：cd code/backend && python3 manage.py runserver 0.0.0.0:8000
+# 前端：cd code/frontend && npm start
+```
+
+### 4. 访问
+- **前端**: http://localhost:3000
+- **后端 API**: http://localhost:8000/api/
+
+---
+
+## 🦞 龙虾舰队
+
+| 龙虾 | 端口 | 专长 | 容器 |
+|------|------|------|------|
+| 飞行侠 🦸 | 18789 | 主力/通用 | openclaw-instance2 |
+| 道童 ☯️ | 18889 | 道德经注解 | openclaw-gateway-2 |
+| 墨子 🔧 | 18689 | 代码专家 | openclaw-coder |
+| 织网者 🕸️ | 18589 | 网站制作 | openclaw-web |
+| 费曼 ⚛️ | 18989 | 物理研究 | openclaw-physics |
+| 守望者 👁️ | 18080 | 舰队监控 | openclaw-watcher |
+
+---
+
+## 📊 功能特性
+
+### ✅ 已完成
+- [x] 龙虾状态监控
+- [x] 实时数据刷新（5 秒）
+- [x] 统计概览面板
+- [x] Git 版本控制
+- [x] 项目文档
+
+### 🟡 开发中
+- [ ] 记忆日历查看
+- [ ] 全文检索
+- [ ] 工具管理页面
+- [ ] 龙虾详情页
+
+---
+
 ## 📁 项目结构

 ```
 monitoring-website/
 ├── code/
 │   ├── frontend/           # React 前端
-│   │   └── src/
-│   │       ├── components/
-│   │       └── pages/
+│   │   ├── public/
+│   │   │   └── index.html  # 主页面
+│   │   ├── src/
+│   │   │   ├── components/ # 组件
+│   │   │   └── pages/      # 页面
+│   │   └── package.json
 │   └── backend/            # Django 后端
+│       ├── api/            # API 应用
+│       │   ├── views.py
+│       │   ├── urls.py
+│       │   └── apps.py
+│       ├── backend/        # 项目配置
+│       │   ├── settings.py
+│       │   └── urls.py
+│       ├── manage.py
+│       └── requirements.txt
 ├── docs/                   # 文档
+│   ├── 需求规格说明书.md
+│   ├── 部署指南.md
+│   └── 使用说明.md
+├── start.sh                # 启动脚本
 └── README.md
 ```

-## 🦞 龙虾列表
+---

-| 龙虾 | 端口 | 专长 |
-|------|------|------|
-| 飞行侠 | 18789 | 主力/通用 |
-| 道童 | 18889 | 道德经注解 |
-| 墨子 | 18689 | 代码专家 |
-| 织网者 | 18589 | 网站制作 |
-| 费曼 | 18989 | 物理研究 |
-| 守望者 | 18080 | 舰队监控 |
+## 🔌 API 接口

-## 📊 功能
+### 获取龙虾列表
+```bash
+GET /api/lobsters/
+```

- ✅ 龙虾状态监控
- 🟡 记忆日历查看
- 🟡 全文检索
- ✅ 工具列表
+### 获取龙虾详情
+```bash
+GET /api/lobsters/{id}/
+```
+
+### 获取龙虾记忆
+```bash
+GET /api/lobsters/{id}/memory/
+```
+
+### 获取工具列表
+```bash
+GET /api/tools/
+```
+
+---
+
+## 🛠️ 技术栈
+
+- **前端**: React, HTML5, CSS3, JavaScript
+- **后端**: Django, Django REST Framework
+- **数据库**: SQLite (开发) / PostgreSQL (生产)
+- **版本控制**: Git
+
+---

 ## 📝 开发日志

- 2026-04-01: 项目初始化，完成基础框架
+- **2026-04-01**: 项目初始化，完成基础框架
+  - ✅ React 前端组件
+  - ✅ Django 后端 API
+  - ✅ Git 仓库建立
+  - ✅ 项目文档
+
+---
+
+## 📄 许可证
+
+MIT License
+
+---
+
+## 👥 团队
+
+- **开发**: 飞行侠 🦸
+- **用户**: 北极星 ⭐
+
+---
+
+## 🔗 链接
+
+- [Git 仓库](https://xjp.datalibstar.com/flying-hero/openclaw-monitor.git)
+- [部署指南](docs/部署指南.md)
+- [使用说明](docs/使用说明.md)