docs: 更新readme文档

2026-03-13 21:53:41 +08:00 · 2023-07-02 20:49:28 +08:00
parent e9dbeec854
commit 08150a2e3c
3 changed files with 277 additions and 36 deletions
--- a/README.md
+++ b/README.md
@@ -1,24 +1,35 @@
-![](https://s1.ax1x.com/2023/05/04/p9NC50f.png)
-
-MallChat的后端项目，是一个既能购物又能即时聊天的电商系统。致力于打造互联网企业级项目的最佳实践。电商该有的购物车，订单，支付，推荐，搜索，拉新，促活，推送，物流，客服，它都必须有。持续更新ing~~(记得star啊喂！)
-
 <p align="center">
-  <a href="#公众号"><img src="https://img.shields.io/badge/公众号-程序员阿斌-blue.svg?style=plasticr"></a>
+    <a href="" target="_blank">
+      <img src="https://s1.ax1x.com/2023/07/02/pCDR0W4.png" width="280" />
+    </a>
+</p>
+
+<h1 align="center">MallChat-抹茶</h1>
+<p align="center"><strong>一个既能购物又能即时聊天的电商系统。致力于打造互联网企业级项目的最佳实践。<br>电商该有的购物车、订单、支付、推荐、搜索、拉新、促活、推送、物流、客服、它都必须有。<em>持续更新 ing～</em></strong></p>
+
+<div align="center">
+ <a href="#公众号"><img src="https://img.shields.io/badge/公众号-程序员阿斌-blue.svg?style=plasticr"></a>
    <a href="#公众号"><img src="https://img.shields.io/badge/交流群-加入开发-green.svg?style=plasticr"></a>
    <a href="https://github.com/zongzibinbin/MallChat"><img src="https://img.shields.io/badge/github-项目地址-yellow.svg?style=plasticr"></a>
    <a href="https://gitee.com/zhongzhibinbin/MallChat"><img src="https://img.shields.io/badge/码云-项目地址-orange.svg?style=plasticr"></a>
    <a href="https://github.com/Evansy/MallChatWeb"><img src="https://img.shields.io/badge/前端-项目地址-blueviolet.svg?style=plasticr"></a>
-</p>
-
+    
+  [![MallChat](https://github.com/Evansy/MallChatWeb/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/Evansy/MallChatWeb/actions/workflows/deploy.yml)
+    <a href="https://github.com/zongzibinbin/MallChat/commits" target="_blank">
+    <img alt="Commit" src="https://img.shields.io/github/commit-activity/m/zongzibinbin/MallChat"></a>
+    <a href="https://github.com/zongzibinbin/MallChat/issues" target="_blank">
+    <img alt="Issues" src="https://img.shields.io/github/issues/zongzibinbin/MallChat"></a> [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/zongzibinbin/MallChat/blob/master/LICENSE)
+    [![GitHub stars](https://img.shields.io/github/stars/zongzibinbin/MallChat.svg?style=social)](https://github.com/zongzibinbin/MallChat/stargazers)
+</div>

 ## 项目导航

-1. **快速体验地址**：[抹茶聊天首页](https://mallchat.cn)
-2. **前端项目仓库**：[MallChatWeb](https://github.com/Evansy/MallChatWeb)
-3. **项目视频记录**：[Bilibili地址](https://space.bilibili.com/146719540) 全程分享项目进度，功能选型的思考，同时征集迭代建议。
-4. **项目学习文档**：10w+字，保姆级教学路线，环境搭建、核心功能、基建轮子、接口压测、问题记录、一个不落。可点击[抹茶项目文档](https://www.yuque.com/snab/planet/cef1mcko4fve0ur3)查看（内含500人交流大群）
-5. **项目交流群**：对抹茶感兴趣的，可以加入[交流群](#公众号)。你的每一个举动，都会决定项目未来的方向。无论是提意见做产品经理，还是找bug做个测试人员，又或者加入开发小模块成为contributer，都欢迎你的加入。
-6. **码云仓库**：[https://gitee.com/zhongzhibinbin/MallChat](https://gitee.com/zhongzhibinbin/MallChat) （国内访问速度更快）
+- **快速体验地址**：[抹茶聊天首页](https://mallchat.cn)
+- **前端项目仓库**：[MallChatWeb](https://github.com/Evansy/MallChatWeb)
+- **项目视频记录**：[Bilibili地址](https://space.bilibili.com/146719540) 全程分享项目进度，功能选型的思考，同时征集迭代建议。
+- **项目学习文档**：10w+字，保姆级教学路线，环境搭建、核心功能、基建轮子、接口压测、问题记录、一个不落。可点击[抹茶项目文档](https://www.yuque.com/snab/planet/cef1mcko4fve0ur3)查看（内含500人交流大群）
+- **项目交流群**：对抹茶感兴趣的，可以加入[交流群](#公众号)。你的每一个举动，都会决定项目未来的方向。无论是提意见做产品经理，还是找bug做个测试人员，又或者加入开发小模块成为contributer，都欢迎你的加入。
+- **码云仓库**：[Gitee](https://gitee.com/zhongzhibinbin/MallChat)（国内访问速度更快）

 ## 项目介绍

@@ -32,7 +43,7 @@ MallChat的后端项目，是一个既能购物又能即时聊天的电商系统

 #### C端项目

- 前端项目地址：[https://github.com/Evansy/MallChatWeb](https://github.com/Evansy/MallChatWeb)
+- 前端源码地址：[https://github.com/Evansy/MallChatWeb](https://github.com/Evansy/MallChatWeb)
 - 项目演示地址：[https://mallchat.cn](https://mallchat.cn) (记住抹茶.cn，下次工作摸鱼可直接打开)

 ![p92nKne.png](./docs/image/群聊截图.jpg)
@@ -62,7 +73,7 @@ MallChat的后端项目，是一个既能购物又能即时聊天的电商系统

 #### 前端技术

-见[MallChatWeb](https://github.com/Evansy/MallChatWeb)
+前往[MallChatWeb](https://github.com/Evansy/MallChatWeb)查看

 ### 环境搭建

@@ -70,57 +81,80 @@ MallChat的后端项目，是一个既能购物又能即时聊天的电商系统

 ### 项目文档

-保姆级教学路线，环境搭建、核心功能、基建轮子、接口压测、问题记录、项目亮点一个不落。点击[项目文档](https://www.yuque.com/snab/planet/cef1mcko4fve0ur3)
+保姆级教学路线，涵盖环境搭建、核心功能实现、基础架构构建、接口压力测试、问题记录以及项目的亮点。无一遗漏持续不断地更新中～  
+查看[项目文档](https://www.yuque.com/snab/planet/cef1mcko4fve0ur3)

-更多有趣功能在持续更新中。。。
-
-![p92Qa2q.png](./docs/image/文档1.jpg)
-
-![p92Qa2q.png](./docs/image/文档2.jpg)
+<div style="display: flex; align-items: center;">
+  <img src="./docs/image/文档1.jpg" alt="文档1" width="50%">
+  <img src="./docs/image/文档2.jpg" alt="文档2" width="47%">
+</div>

 ## star 趋势图

 ![Stargazers over time](https://starchart.cc/zongzibinbin/MallChat.svg)

-## 贡献者
+## 贡献
+**贡献之前请先阅读[行为准则](CODE_OF_CONDUCT.md) 和 贡献指南。感谢所有为 MallChat 做过贡献的人!**
+
+#### 后端:
+
 <a href="https://github.com/zongzibinbin/MallChat/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=zongzibinbin/MallChat" />
+</a>  
+
+#### 前端:
+
+<a href="https://github.com/Evansy/MallChatWeb/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=Evansy/MallChatWeb" />
 </a>

 <h4>优秀贡献者:</h4>
+
 <table>
-    <tr border>
-    <th width="30%">用户</th>
+  <tr>
+    <th>类别</th>
+    <th>用户</th>
    <th>贡献模块</th>
  </tr>
-    <tr>
-    <td align="center" rowspan="3"><a href="https://github.com/LIjiAngChen8"><img src="https://avatars.githubusercontent.com/u/48879481?v=4" style="border-radius: 50%; width: 100px; height: 100px;"></a></td>
-    <td><a href="https://github.com/Evansy/MallChatWeb/pull/72">前端 图片，语音，文件类型消息</a></td>
+  <tr>
+    <td rowspan="3">前端</td>
+    <td rowspan="3">
+      <a href="https://github.com/LIjiAngChen8"><img src="https://avatars.githubusercontent.com/u/48879481?v=4" style=" width: 80px; height: 80px;"></a>
+    </td>
+    <td><a href="https://github.com/Evansy/MallChatWeb/pull/74">图片、语音、文件类型消息收发</a></td>
  </tr>
  <tr>
-    <td><a href="https://github.com/Evansy/MallChatWeb/pull/50">前端 撤回消息</a></td>
-  </tr>
-     <tr>
-    <td><a href="https://github.com/Evansy/MallChatWeb/pull/28">前端 消息点赞</a></td>
+    <td><a href="https://github.com/Evansy/MallChatWeb/pull/50">消息互动操作(撤回、点赞、删除)</a></td>
  </tr>
  <tr>
-    <td align="center" rowspan="2"><a href="https://github.com/1045078399"><img src="https://avatars.githubusercontent.com/u/82020261?v=4" style="border-radius: 50%; width: 100px; height: 100px;"></a></td>
+    <td><a href="https://github.com/Evansy/MallChatWeb/pull/17">虚拟列表</a></td>
+  </tr>
+  <tr>
+    <td rowspan="3">后端</td>
+    <td rowspan="2">
+      <a href="https://github.com/1045078399"><img src="https://avatars.githubusercontent.com/u/82020261?v=4" style=" width: 80px; height: 80px;"></a>
+    </td>
    <td><a href="https://github.com/zongzibinbin/MallChat/pull/31">DFA敏感词检测</a></td>
  </tr>
  <tr>
    <td><a href="https://github.com/zongzibinbin/MallChat/pull/64">OpenAI聊天机器人</a></td>
  </tr>
-    <tr>
-    <td align="center"><a href="https://github.com/xiaocairush"><img src="https://avatars.githubusercontent.com/u/6416523?v=4" style="border-radius: 50%; width: 100px; height: 100px;"></a></td>
-    <td><a href="https://github.com/zongzibinbin/MallChat/pull/42">ac自动机敏感词检测</a></td>
+  <tr>
+    <td rowspan="1">
+      <a href="https://github.com/xiaocairush"><img src="https://avatars.githubusercontent.com/u/6416523?v=4" style=" width: 80px; height: 80px;"></a>
+    </td>
+    <td><a href="https://github.com/zongzibinbin/MallChat/pull/99">Ac自动机敏感词检测</a></td>
  </tr>
 </table>



+
+
+## License
+[Apache License 2.0](./LICENSE)
 ## 公众号

 微信搜索 **阿斌Java之路** 关注我的原创公众号，后台回复「**抹茶**」即可加入抹茶交流群，一些做过公司万人群聊，高并发的小伙伴都在里面讨论方案。公众号也会经常更新项目相关的文档，等你来撩~~

 ![p9211Ag.png](https://s1.ax1x.com/2023/05/15/p9211Ag.png)
-