# online-chat

**Repository Path**: SLoTHs-6/online-chat

## Basic Information

- **Project Name**: online-chat
- **Description**: websocket实现在线聊天室
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-06-25
- **Last Updated**: 2025-06-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Online-Chat

## 项目介绍
本项目为基于 WebSocket 的在线聊天室系统，采用前后端分离架构。前端基于 Vue3 + TypeScript + Element Plus，后端基于 Spring Boot，支持用户注册、登录、群聊、私聊、消息管理、用户权限管理等功能，消息实时通信采用 WebSocket 实现。

## 软件架构
- 前端：Vue3、TypeScript、Element Plus、Axios
- 后端：Spring Boot、Spring WebSocket、MyBatis-Plus、JWT
- 数据库：MySQL 8.0+
- 通信协议：WebSocket（消息）、HTTP（接口）

## 安装教程

1. 克隆本仓库到本地
2. 配置并启动数据库（MySQL 8.0+），导入 `chat-server/src/main/resources/chat.sql`
3. 配置后端数据库连接（`chat-server/src/main/resources/application.yml`）
4. 启动后端服务（`mvn clean package`，`java -jar target/chat-server.jar`）
5. 安装前端依赖并启动前端（`cd chat-ui`，`npm install`，`npm run dev`）

## 使用说明

1. 浏览器访问前端页面（默认 http://localhost:8080）
2. 注册新用户或使用初始化账号登录
3. 进入聊天室进行群聊或私聊
4. 管理员可在管理界面对用户进行禁言、踢人等操作

## 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

## 其他说明

- 前端打包后可通过 Nginx 等静态服务器部署
- 后端为 Spring Boot 应用，默认端口 8888，可在配置文件中修改
- 如遇问题请提交 issue 或联系开发者

## License

本项目仅供学习交流使用，禁止用于商业用途。