Merge remote-tracking branch 'origin/master'

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 blue
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,38 +1,92 @@
 
 ### 项目介绍
 
-仿微信实现的网页版聊天软件，后端使用springboot+netty实现，前端使用vue。
-目前是1.0.0版本，仅支持私聊文字消息，后续会陆续上线群聊、发送表情、图片等功能
+1. 盒子IM是一个仿微信实现的网页版聊天软件，目前完全开源，仅用于学习和交流。
+1. 支持私聊、群聊、离线消息、发送图片、文件、好友在线状态显示等功能。
+1. 后端采用springboot+netty实现，前端使用vue。
+1. 服务器支持集群化部署，每个im-server仅处理自身连接用户的消息
 
-### 主要功能
 
-目前功能：
 
-- 好友在线状态显示
-- 实时发送私聊消息，上线后自动接收离线消息
-- 支持服务器集群化部署
+
+#### 在线体验
+体验地址：http://8.134.92.70/
+
+账号：
+张三/123456
+李四/123456
+
+也可以自行注册账号哟！
+
+
 
 
 #### 项目结构
 |  模块  |     功能 |
 |-------------|------------|
 | im-platform | 与页面进行交互，处理业务请求 |
-| im-server   | 推送聊天消息       |
-| im-common    | 公共包  
+| im-server   | 推送聊天消息|
+| im-common   | 公共包  |
+
+
+
+#### 本地快速部署
+1.安装运行环境
+- 安装node:v14.16.0
+- 安装jdk:1.8
+- 安装maven:3.6.3
+- 安装mysql:5.7,密码分别为root/root
+- 安装redis:4.0
+- 安装minio，命令端口使用9001，并创建一个名为"box-im"的bucket，并设置访问权限为公开
+
+
+
 
+2.启动后端服务
+```
+mvn clean package
+java -jar ./im-platform/target/im-platform.jar
+java -jar ./im-server/target/im-server.jar
+```
 
-#### 安装教程
+3.启动前端ui
+```
+cd im-ui
+npm install
+npm run serve
+```
 
-后续补充
+4.访问localhost:8080
+
+
+
+
+#### 界面截图
+文字聊天：
+![输入图片说明](%E6%88%AA%E5%9B%BE/%E6%96%87%E5%AD%97%E8%81%8A%E5%A4%A9.jpg)
+
+发送图片、文件：
+![输入图片说明](%E6%88%AA%E5%9B%BE/%E5%8F%91%E9%80%81%E5%9B%BE%E7%89%87%E6%96%87%E4%BB%B6.jpg)
+
+群聊：
+![输入图片说明](%E6%88%AA%E5%9B%BE/%E7%BE%A4%E8%81%8A.jpg)
+
+好友列表：
+![输入图片说明](%E6%88%AA%E5%9B%BE/%E5%A5%BD%E5%8F%8B%E5%88%97%E8%A1%A8.jpg)
+
+群聊列表：
+![输入图片说明](%E6%88%AA%E5%9B%BE/%E7%BE%A4%E8%81%8A%E5%88%97%E8%A1%A8.jpg)
 
 
-#### 页面截图
-![输入图片说明](%E6%88%AA%E5%9B%BE/%E8%81%8A%E5%A4%A9.png)
 
-![输入图片说明](%E6%88%AA%E5%9B%BE/%E5%A5%BD%E5%8F%8B.png)
 
-#### 体验地址
-尚未发布，敬请期待...
 
 #### 联系方式
 QQ: 825657193
+邮箱：825657193@qq.com
+
+有任何问题，欢迎给我留言哦
+
+
+#### 最后
+撸码不易，喜欢的朋友麻烦点个star吧！