Skip to content

hlfzsi/LazyTea-Web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LazyTea Web

—— 在任何设备上,都能享受丝滑的下午茶时光。 ——

GitHub release

LazyTea Web 是 LazyTea 生态系统中的 Web 客户端,基于现代化的 FastAPI 框架构建,为 LazyTea 后端服务提供了优雅的 Web 管理界面。无论您使用何种设备和操作系统,只要有浏览器,就能随时随地管理您的 NoneBot2 机器人。

📌 项目关系

为了更好地理解 LazyTea 生态,请注意以下几个项目的区别与联系:

项目 主要职责 仓库地址
🌐LazyTea Web (本项目) Web管理界面,提供跨平台的浏览器访问体验。 LazyTea-Web
💻LazyTea Client 独立桌面客户端,功能更全面的原生应用。 LazyTea-Client
📱LazyTea Mobile 跨平台移动客户端,随时随地管理机器人。 LazyTea-mobile
🔌nonebot_plugin_lazytea NoneBot2 插件,作为 LazyTea 的后端服务端。 nonebot_plugin_lazytea
🐚lazytea-shell-extension 命令行扩展,允许通过聊天消息执行管理命令。 lazytea-shell-extension

简单来说,您需要在您的机器人上安装 nonebot_plugin_lazytea 作为服务端,然后通过浏览器访问本 Web 界面,即可开始图形化管理您的机器人。


✨ 优势

LazyTea Web 在继承 LazyTea 生态系统核心优势的基础上,提供了独特的 Web 体验:

无处不在的访问能力

  • 跨平台兼容: 支持所有现代浏览器,无论是 Windows、macOS、Linux 还是移动设备。
  • 免安装使用: 无需下载客户端,打开浏览器即可开始管理您的机器人。
  • 响应式设计: 自适应各种屏幕尺寸,从手机到大屏幕都有优秀的显示效果。

现代化技术架构

  • 高性能后端 (FastAPI): 基于现代异步框架,提供快速的 API 响应。
  • 安全可靠: 内置 HTTPS 支持、JWT 身份验证和 CSRF 保护。
  • 实时通信: 基于 WebSocket 实现与 NoneBot2 的实时数据同步。

优雅的用户体验

  • 直观的界面设计: 清晰的导航结构和现代化的 UI 设计。
  • 丰富的功能模块: 概览仪表板、插件管理、消息监控、权限控制等核心功能。
  • 智能缓存机制: 优化数据加载速度,减少不必要的网络请求。

🚀 快速入门

1. 系统要求

配置级别 最低要求 推荐配置
Python 3.12+ 3.12+
内存 50 MB 100 MB+
硬盘空间 30 MB 50 MB+

2. 安装与配置

方式一:直接运行 (推荐)

  1. 下载项目:

    git clone https://github.com/hlfzsi/LazyTea-Web.git
    cd LazyTea-Web
  2. 安装依赖:

    pip install uv  # 如果还没有安装 uv
    uv sync
  3. 启动服务:

    python main.py

方式二:使用预编译版本

  1. 前往 Releases 页面下载最新的 LazyTea-Server.exe
  2. 双击运行,Web 服务将自动启动。

3. 首次配置

  1. 安装后端服务: 确保您的 NoneBot2 项目中已正确安装并运行 nonebot_plugin_lazytea 插件。

    nb plugin install nonebot_plugin_lazytea
  2. 获取连接信息: 从 NoneBot2 的启动日志中获取连接所需的 IPPORTTOKEN

  3. 访问 Web 界面: 在浏览器中访问 http://localhost:8080(默认端口)。

  4. 连接配置: 在首次访问时,输入上一步获取的连接信息即可开始使用。

4. 配置选项

Web 服务支持多种配置选项,可通过配置文件进行设置, 也可根据引导进行配置。


🌟 功能特性

📊 概览仪表板

  • 机器人运行状态实时监控
  • 系统资源使用情况
  • 插件调用统计图表
  • 消息处理数据分析

🔌 插件管理

  • 插件列表查看与搜索
  • 插件配置可视化编辑
  • 插件启用/禁用控制
  • 插件版本检查与更新

💬 消息监控

  • 实时消息流展示
  • 消息搜索与过滤
  • 话题追踪与关键词提取
  • 消息统计与分析

🛡️ 权限管理

  • 用户权限精细化控制
  • 群组权限批量设置
  • 黑白名单管理
  • 权限规则可视化配置

🤖 Bot 管理

  • 多 Bot 实例支持
  • Bot 状态监控
  • 连接配置管理
  • 运行日志查看

🔧 开发与部署

开发环境搭建

  1. 克隆仓库:

    git clone https://github.com/hlfzsi/LazyTea-Web.git
    cd LazyTea-Web
  2. 安装开发依赖:

    uv sync --dev
  3. 启动开发服务器:

    python main.py

生产环境部署

使用 Docker (推荐)

# 构建镜像
docker build -t lazytea-web .

# 运行容器
docker run -p 8080:8080 -d lazytea-web

使用 systemd

# /etc/systemd/system/lazytea-web.service
[Unit]
Description=LazyTea Web Service
After=network.target

[Service]
Type=simple
User=www-data
WorkingDirectory=/opt/lazytea-web
ExecStart=/opt/lazytea-web/main
Restart=always

[Install]
WantedBy=multi-user.target

🗺️ 项目蓝图

开发计划

  • 基础 Web 界面: 完成核心功能的 Web 化实现。
  • 响应式设计: 支持各种屏幕尺寸的设备访问。
  • API 文档: 完善的 REST API 文档和 SDK。

版本管理

本项目遵循语义化版本控制 (SemVer):

  • 补丁版本 (0.0.X): Bug 修复和小幅改进
  • 次版本 (0.X.0): 新功能添加和非破坏性更改
  • 主版本 (X.0.0): 重大架构调整和破坏性更改

友情链接


Star History

About

LazyTea的Web服务器实现

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors