EasyChat

介绍

EasyChat是一个在线聊天室的后端，基于 SpringBoot + Mybatis-Plus 实现。

项目前端地址:

技术栈

SpringBoot 、Spring Security、Spring Doc、Spring Websocket、Spring Cache、Mybatis-Plus、Minio、Redis、MySQL

功能列表

基础模块

• 登录/注册
• 邮箱验证码
• 消息缓存
• 权限认证

用户模块

• 修改个人信息（密码/邮箱/昵称/头像）
• 登录设备管理

好友模块

• 添加/删除好友
• 好友备注
• 消息免打扰

群聊模块

• 创建群聊
• 群聊备注
• 退出/解散群聊
• 踢出群成员
• 设置/取消管理员身份
• 禁言/解除禁言
• 屏蔽群成员

消息模块

• 表情消息
• 图片消息
• 文件消息

部署

本地部署

1. 新建配置文件application-my.yaml放置于 src/main/resources目录下 ，填写数据库用户名和密码，并配置 Spring mail 和 minio 的账号。

# 修改配置信息
spring:
  # CHANGE THIS
  mail:
    host: smtp.gmail.com
    password: password
    username: email
    port: 465
# CHANGE THIS
  datasource:
    username: root
    password: 123456
    url: jbdc:mysql://localhost:3306/easychat
easy-chat:
  # CHANGE THIS IF NEEDED
  minio:
    access-key: minioadmin
    secret-key: miniopassword

2. 启动 MySQL，将数据表结构 sql/easychat.sql 导入数据库

3. 启动 redis 和 minio 服务，默认端口6379和9000

4. 启动项目

./gradlew bootRun

Docker 部署

1. 新建配置文件application-my.yaml放置于 src/main/resources目录下 ，配置 Spring mail 信息。

无需修改mysql、redis和minio连接信息，如需要修改，请在docker-compose.yml文件中一并修改

# 修改配置信息
spring:
  # CHANGE THIS
  mail:
    host: smtp.gmail.com
    password: password
    username: email
    port: 465
  # DO NOT CHANGE
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://db:3306/easychat
  # DO NOT CHANGE
  data:
    redis:
      host: redis
      port: 6379
easy-chat:
  # DO NOT CHANGE
  minio:
    access-key: minioadmin
    secret-key: miniopassword
    endpoint: http://minio:9000

2. 使用 docker-compose 启动

docker-compose up -d

LICENSE

MIT

Copyright (c) 2024 th1nker