XQFChat: 现代化现代化实时聊天系统
XQFChat 是一款个人级实时聊天解决方案,融合了简洁界面与强大功能,支持多房间通信、文件协作与机器人集成,为团队协作和社区交流提供高效平台。
注:此项目目前处于测试阶段如有问题请: https://gitee.com/XiaoFengQWQ/xqfchat/issues
✨ 核心特性
- 富媒体支持:
- 多维度协作:
- 扩展能力:
🛠️ 技术架构
| 模块 | 技术栈 | 核心组件 |
|---|---|---|
| 前端 | HTML5, CSS3, JavaScript | MDUI框架, 自定义组件系统 |
| 后端 | PHP 8.0+ | 自研MVC框架, PSR-4自动加载 |
| 通信 | HTTP/HTTPS | 消息轮询 |
| 存储 | MySQL 8.0 | 消息索引, 文件元数据 |
| 扩展 | API, Webhook | 事件回调, 第三方集成 |
📦 快速部署
环境要求
- PHP 8.2+ (需开启gd, fileinfo, curl,Redis(可选)扩展)
- MySQL 5.7+ 或 MariaDB 10.5+ Redis(Webhook推送队列)
- Web服务器 (Nginx/Apache)
- Composer (依赖管理)
安装步骤
# 克隆仓库
git clone https://gitee.com/XiaoFengQWQ/xqfchat.git
cd xqfchat
# 安装依赖
composer install
# 启动内置服务器(开发环境)
php -S localhost:8000
🔌 开发接口
API 集成
系统提供标准化RESTful接口,支持用户认证、消息管理、房间操作等功能:
POST /api/v1/chat/send HTTP/1.1Authorization: Bearer {token}
Content-Type: application/json
{
"room_id": 42,
"content": "Hello World",
"is_markdown": false
}
详细接口文档请查阅 API 参考手册
机器人开发
通过Webhook实现自动化交互,支持消息监听、定时任务等场景:
// 事件回调示例 (消息接收)
{
"event": "message.received",
"data": {"message_id": 12345,
"room_id": 42,
"sender": {
"id": 789,
"name": "User"
},
"content": "请查询今日天气",
"timestamp": 1620000000
}
}
机器人开发指南见 Webhook 文档
📄 许可证
本项目采用 Apache License 2.0 开源许可,详情参见 LICENSE 文件。
Copyright 2025 XiaoFengQWQLicensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
</code></pre><h2 style="text-align: start;">🤝 贡献指南</h2><p style="text-align: start;">欢迎通过Issue提交反馈或直接PR参与开发,贡献前请阅读 <a href="https://gitee.com/XiaoFengQWQ/xqfchat/blob/main/CONTRIBUTING.md" target="">贡献规范</a>。</p><p style="text-align: start;"><br></p><p style="text-align: start;"><br></p><p><br></p>