更新md

2026-03-13 20:53:42 +08:00 · 2025-02-05 23:43:19 +08:00
parent 6bee658de9
commit 9cb6b6327d
29 changed files with 200 additions and 83 deletions
--- a/README.en.md
+++ b/README.en.md
@@ -1,36 +0,0 @@
-# ruoyi-ai-pro
-
-#### Description
-ruoyi-ai-pro
-
-#### Software Architecture
-Software architecture description
-
-#### Installation
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### Instructions
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### Contribution
-
-1.  Fork the repository
-2.  Create Feat_xxx branch
-3.  Commit your code
-4.  Create Pull Request
-
-
-#### Gitee Feature
-
-1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
-2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
-3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
-4.  The most valuable open source project [GVP](https://gitee.com/gvp)
-5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
-6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
--- a/README.md
+++ b/README.md
@@ -1,62 +1,215 @@
-## 平台简介

-> 基于ruoyi-plus实现AI聊天和绘画功能-后端

-> 本项目完全开源免费！
-后台管理界面使用elementUI服务端使用Java17+SpringBoot3.X
+# RuoYi AI

-实现功能
-1. 支持ChatGPT4,Dall-E-3,ChatGPT-4-All,GPTS 模型
-2. 支持语音克隆
-3. 支持文生图模型
-4. 支持微信小程序
-5. 支持个人二维码实时到账(易支付)
-6. 支持个人微信接入ChatGPT
-> 
->项目地址
-<ul>
-<li>小程序端: https://github.com/ageerle/ruoyi-uniapp</li>
-<li>前端-后台管理: https://github.com/ageerle/ruoyi-admin</li>
-<li>前端-用户端: https://github.com/ageerle/ruoyi-web</li>
-<li>演示地址: https://web.pandarobot.chat</li>
-</ul>

-## 小程序演示
-<div>
-  <img style="margin:10px" src="./image/03.png" alt="drawing" width="300px" height="400px"/>
-  <img style="margin:10px" src="./image/04.png" alt="drawing" width="300px" height="400px"/>
+
+<!-- PROJECT SHIELDS -->
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+
+
+<!-- PROJECT LOGO -->
+<br />
+
+
+<img style="text-align: center;" src="images/00.png" alt="Logo" width="150" height="150">
+
+<h3 style="text-align: center;">快速搭建属于自己的 AI 助手平台</h3>
+
+<p style="text-align: center;">
+    全新升级，开箱即用，简单高效
+    <br />
+    <a href="https://doc.pandarobot.chat"><strong>探索本项目的文档 »</strong></a>
+    <br />
+    <br />
+    <a href="https://web.pandarobot.chat">项目预览</a>
+    ·
+    <a href="https://github.com/ageerle/ruoyi-ai/issues">报告Bug</a>
+    ·
+    <a href="https://github.com/ageerle/ruoyi-ai/issues">提出新特性</a>
+</p>
+
+## 目录
+
+- [源码地址](#源码地址)
+- [特色功能](#特色功能)
+- [项目演示](#项目演示)
+  - [后台管理](#后台管理)
+  - [用户端](#用户端)
+  - [小程序端](#小程序端)
+- [开发前的配置要求](#开发前的配置要求)
+- [文件目录说明](#文件目录说明)
+- [使用到的框架](#使用到的框架)
+- [贡献者](#贡献者)
+  - [如何参与开源项目](#如何参与开源项目)
+- [版本控制](#版本控制)
+- [作者](#作者)
+- [鸣谢](#鸣谢)
+
+### 源码地址
+- 前端-后台管理: https://github.com/ageerle/ruoyi-admin
+- 前端-用户端: https://github.com/ageerle/ruoyi-web
+- 小程序端: https://github.com/ageerle/ruoyi-uniapp
+- 演示地址: https://web.pandarobot.chat
+- 后台管理: https://admin.pandarobot.chat
+- 用户名: admin 密码：admin123
+
+### 特色功能
+1. 内置SSE、websocket等网络协议，支持对接OpenAI、Azure、ChatGLM、讯飞星火等大语言模型
+2. 支持接入个人微信或企业微信
+3. 支持易支付、微信支付和Stripe国际信用卡支付
+4. 提供邮箱登录和微信公众号登录
+5. 支持知识库功能，支持AI翻译、AI PPT制作、语音克隆和AI翻唱
+6. 提供完整的前端应用、后台管理以及小程序应用，全部开箱即用。基于MIT开源协议
+
+
+### 项目演示
+
+#### 后台管理
+<div style="display: flex; flex-wrap: wrap; gap: 20px; justify-content: center;">
+  <img src="image/02.png" alt="drawing" style="width: 450px; height: 300px; border: 2px solid #ddd; border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"/>
+  <img src="image/03.png" alt="drawing" style="width: 450px; height: 300px; border: 2px solid #ddd; border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"/>
+  <img src="image/04.png" alt="drawing" style="width: 450px; height: 300px; border: 2px solid #ddd; border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"/>
+  <img src="image/05.png" alt="drawing" style="width: 450px; height: 300px; border: 2px solid #ddd; border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"/>
 </div>

-## H5演示
-<div>
-  <img style="margin:10px" src="./image/05.png" alt="drawing" width="300px" height="400px"/>
-  <img style="margin:10px" src="./image/06.png" alt="drawing" width="300px" height="400px"/>
+
+#### 用户端
+<div style="display: flex; flex-wrap: wrap; gap: 20px; justify-content: center;">
+  <img src="image/08.png" alt="drawing" style="width: 450px; height: 300px; border: 2px solid #ddd; border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"/>
+  <img src="image/09.png" alt="drawing" style="width: 450px; height: 300px; border: 2px solid #ddd; border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"/>
+  <img src="image/10.png" alt="drawing" style="width: 450px; height: 300px; border: 2px solid #ddd; border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"/>
+  <img src="image/11.png" alt="drawing" style="width: 450px; height: 300px; border: 2px solid #ddd; border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"/>
 </div>

-## PC端演示
-<div>
-  <img style="margin-top:10px" src="./image/07.png" alt="drawing" width="550px" height="300px"/>
-  <img style="margin-top:10px" src="./image/08.png" alt="drawing" width="550px" height="300px"/>
+#### 小程序端
+<div style="display: flex; flex-wrap: wrap; gap: 20px; justify-content: flex-start;">
+  <img src="image/06.png" alt="drawing" style="width: 320px; height: 600px; border: 2px solid #ddd; border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"/>
+  <img src="image/07.png" alt="drawing" style="width: 320px; height: 600px; border: 2px solid #ddd; border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);"/>
 </div>

-## MJ绘图
+### 开发前的配置要求
+
+1. jdk 17
+2. mysql 5.7、8.0
+3. redis 版本必须 >= 5.X
+4. maven 3.8+
+5. nodejs 20+ & pnpm
+
+### 文件目录说明
+RuoYi-AI
+
+```
+├─ ruoyi-admin                         // 管理模块
+│  └─ RuoYiApplication                 // 启动类
+│  └─ RuoYiServletInitializer          // 容器部署初始化类
+│  └─ resources                        // 资源文件
+│      └─ i18n/messages.properties     // 国际化配置文件
+│      └─ application.yml              // 框架总配置文件
+│      └─ application-dev.yml          // 开发环境配置文件
+│      └─ application-prod.yml         // 生产环境配置文件
+│      └─ banner.txt                   // 框架启动图标
+│      └─ logback-plus.xml             // 日志配置文件
+│      └─ ip2region.xdb                // IP区域地址库
+├─ ruoyi-common                        // 通用模块
+│  └─ ruoyi-common-bom                 // common依赖包管理
+   └─ ruoyi-common-chat                // 聊天模块
+│  └─ ruoyi-common-core                // 核心模块
+│  └─ ruoyi-common-doc                 // 系统接口模块
+│  └─ ruoyi-common-encrypt             // 数据加解密模块
+│  └─ ruoyi-common-excel               // excel模块
+│  └─ ruoyi-common-idempotent          // 幂等功能模块
+│  └─ ruoyi-common-json                // 序列化模块
+│  └─ ruoyi-common-log                 // 日志模块
+│  └─ ruoyi-common-mail                // 邮件模块
+│  └─ ruoyi-common-mybatis             // 数据库模块
+│  └─ ruoyi-common-oss                 // oss服务模块
+│  └─ ruoyi-common-pay                 // 支付模块
+│  └─ ruoyi-common-ratelimiter         // 限流功能模块
+│  └─ ruoyi-common-redis               // 缓存服务模块
+│  └─ ruoyi-common-satoken             // satoken模块
+│  └─ ruoyi-common-security            // 安全模块
+│  └─ ruoyi-common-sensitive           // 脱敏模块
+│  └─ ruoyi-common-sms                 // 短信模块
+│  └─ ruoyi-common-sse                 // sse流推送模块（待更新）
+│  └─ ruoyi-common-tenant              // 租户模块
+│  └─ ruoyi-common-translation         // 通用翻译模块
+│  └─ ruoyi-common-web                 // web模块
+│  └─ ruoyi-common-websocket           // websocket服务集成模块（待更新）
+├─ ruoyi-modules                       // 模块组
+│  └─ ruoyi-demo                       // 演示模块
+│  └─ ruoyi-generator                  // 代码生成模块
+│  └─ ruoyi-system                     // 业务模块
+├─ .run                 // 执行脚本文件
+├─ .editorconfig        // 编辑器编码格式配置
+├─ LICENSE              // 开源协议
+├─ pom.xml              // 公共依赖
+├─ README.md            // 框架说明文件
+
+
+```
+
+### 使用到的框架
+
+- [Vben Admin](https://github.com/vbenjs/vue-vben-admin)
+- [Naive UI](https://www.naiveui.com)
+- [RuoYi-Vue-Plus](https://gitee.com/dromara/RuoYi-Vue-Plus)
+
+### 贡献者
+
+请阅读[CONTRIBUTING](https://github.com/ageerle/ruoyi-ai/graphs/contributors) 查阅为该项目做出贡献的开发者。
+
+#### 如何参与开源项目
+
+贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是**非常感谢**的。
+
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+
+
+### 版本控制
+
+该项目使用Git进行版本管理。您可以在repository参看当前可用版本。
+
+### 进群学习
+
 <div>
-  <img style="margin-top:10px" src="./image/10.png" alt="drawing" width="550px" height="300px"/>
-  <img style="margin-top:10px" src="./image/11.png" alt="drawing" width="550px" height="300px"/>
+  <img src="image/01.png" alt="drawing" width="300px" height="300px"/>
 </div>

-## 私有知识库管理
-<div>
-  <img style="margin-top:10px;width:50%" src="./image/12.png" alt="drawing" width="550px" height="300px"/>
-  <img style="margin-top:10px;width:50%" src="./image/私有知识库业务架构图.drawio.png" alt="drawing" width="550px" height="300px"/>
-</div>
+### 版权说明
+
+该项目签署了MIT 授权许可，详情请参阅 [LICENSE.txt](https://github.com/ageerle/ruoyi-ai/blob/master/LICENSE.txt)
+
+### 鸣谢
+- [chatgpt-java](https://github.com/Grt1228/chatgpt-java)
+- [RuoYi-Vue-Plus](https://gitee.com/dromara/RuoYi-Vue-Plus)
+- [chatgpt-web-midjourney-proxy](https://github.com/Dooy/chatgpt-web-midjourney-proxy)
+
+
+<!-- links -->
+[your-project-path]:https://github.com/ageerle/ruoyi-ai
+[contributors-shield]: https://img.shields.io/github/contributors/ageerle/ruoyi-ai.svg?style=flat-square
+[contributors-url]: https://github.com/ageerle/ruoyi-ai/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/ageerle/ruoyi-ai.svg?style=flat-square
+[forks-url]: https://github.com/ageerle/ruoyi-ai/network/members
+[stars-shield]: https://img.shields.io/github/stars/ageerle/ruoyi-ai.svg?style=flat-square
+[stars-url]: https://github.com/ageerle/ruoyi-ai/stargazers
+[issues-shield]: https://img.shields.io/github/issues/ageerle/ruoyi-ai.svg?style=flat-square
+[issues-url]: https://img.shields.io/github/issues/ageerle/ruoyi-ai.svg
+[license-shield]: https://img.shields.io/github/license/ageerle/ruoyi-ai.svg?style=flat-square
+[license-url]: https://github.com/ageerle/ruoyi-ai/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
+

-## 进群学习
-<div>
-  <img src="./image/01.png" alt="drawing" width="300px" height="300px"/>
-</div>

-## 参考项目
-<ol>
-<li>https://github.com/Grt1228/chatgpt-java</li>
-<li>https://github.com/Dooy/chatgpt-web-midjourn
--- a/image/00.png
+++ b/image/00.png
--- a/image/02.png
+++ b/image/02.png
--- a/image/03.png
+++ b/image/03.png
--- a/image/04.png
+++ b/image/04.png
--- a/image/05.png
+++ b/image/05.png
--- a/image/06.png
+++ b/image/06.png
--- a/image/07.png
+++ b/image/07.png
--- a/image/08.png
+++ b/image/08.png
--- a/image/09.png
+++ b/image/09.png
--- a/image/10.png
+++ b/image/10.png
--- a/image/11.png
+++ b/image/11.png
--- a/image/12.png
+++ b/image/12.png
--- a/image/13.png
+++ b/image/13.png
--- a/image/14.png
+++ b/image/14.png
--- a/image/15.png
+++ b/image/15.png
--- a/image/16.png
+++ b/image/16.png
--- a/image/17.png
+++ b/image/17.png
--- a/image/18.png
+++ b/image/18.png
--- a/image/19.png
+++ b/image/19.png
--- a/image/20.png
+++ b/image/20.png
--- a/image/21.png
+++ b/image/21.png
--- a/image/22.png
+++ b/image/22.png
--- a/image/23.png
+++ b/image/23.png
--- a/image/24.png
+++ b/image/24.png
--- a/image/25.png
+++ b/image/25.png
--- a/image/私有知识库业务架构图.drawio.png
+++ b/image/私有知识库业务架构图.drawio.png
--- a/img.png
+++ b/img.png