# firechat

**Repository Path**: xiaGjbgo-jian/firechat

## Basic Information

- **Project Name**: firechat
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-05
- **Last Updated**: 2025-10-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

该项目旨在提供一个基于WebSocket的实时聊天应用，包含前端和后端两个部分。以下是项目的结构和主要功能说明：

---

## 项目概述

这是一个使用 Flask-SocketIO 作为后端通信框架，结合 Python 的 PyQt5 库实现图形界面的实时聊天应用程序。项目分为两个主要部分：后端提供用户注册、登录和消息传递功能，前端实现用户界面和实时交互。

---

## 功能特性

### 后端功能
- **用户管理**：支持用户注册和登录功能，包含密码加密存储和验证。
- **实时通信**：通过 WebSocket 实现用户连接、断开连接、在线状态同步。
- **消息传递**：
  - 公共聊天：所有在线用户可以接收和发送消息。
  - 私人聊天：点对点消息传递功能。

### 前端功能
- **登录与注册**：用户可以通过界面登录或注册账户。
- **实时聊天界面**：
  - 支持公共聊天和私人聊天。
  - 实时更新在线用户列表。
  - 支持快捷键操作（如 Ctrl+P 切换公共聊天）。
- **WebSocket 客户端**：与后端建立连接，处理实时消息收发。

---

## 技术栈

- **后端**：
  - Python
  - Flask
  - Flask-SocketIO
  - SQLAlchemy（用于用户和消息数据管理）

- **前端**：
  - Python
  - PyQt5（用于图形界面开发）

---

## 安装与运行

### 后端安装步骤
1. 安装依赖：
   ```bash
   pip install flask flask-socketio flask-sqlalchemy
   ```
2. 运行后端服务：
   ```bash
   python backend/main.py
   ```

### 前端安装步骤
1. 安装依赖：
   ```bash
   pip install PyQt5
   ```
2. 启动前端界面：
   ```bash
   python frontend/chat.py
   ```

---

## 使用说明

1. **登录或注册**：打开前端界面，输入用户名和密码进行登录或注册。
2. **公共聊天**：在主聊天窗口发送消息，所有在线用户将实时收到。
3. **私人聊天**：选择在线用户，点击私聊按钮，即可发送点对点消息。
4. **在线用户列表**：界面右侧显示当前在线用户，实时更新连接状态。

---

## 注意事项

- 确保后端服务已启动，前端才能正常连接。
- 项目中 `malword.py` 文件用于内容过滤，具体功能需查看代码实现。
- 项目未提供 README 文件，当前文档为根据代码结构生成的说明。

---

## 开源许可

该项目遵循开源协议，请查看仓库中的 LICENSE 文件以获取详细信息。

---

## 联系方式

如需进一步了解或贡献代码，请访问 [Gitee 仓库地址](https://gitee.com/xiaGjbgo-jian/firechat)。