ruoyi-ai/README.md

RuoYi AI

快速搭建属于自己的 AI 助手平台

全新升级，开箱即用，简单高效
探索本项目的文档 »

项目预览 · 报告Bug · 提出新特性

目录

• 源码地址
• 特色功能
• 项目演示
  • 后台管理
  • 用户端
  • 小程序端
• 开发前的配置要求
• 文件目录说明
• 使用到的框架
• 贡献者
  • 如何参与开源项目
• 版本控制
• 作者
• 鸣谢

源码地址

• 项目文档: https://doc.pandarobot.chat
• 前端-后台管理: 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. 全套开源系统：提供完整的前端应用、后台管理以及小程序应用，基于MIT协议，代码可灵活修改分发，开箱即用。
2. 本地RAG解决方案：集成Milvus/Weaviate向量库、本地向量化模型与Ollama，实现本地化RAG，保障数据隐私与性能。
3. 丰富插件功能：支持联网、SQL查询及Text2API插件，扩展系统能力与应用场景。
4. 丰富的模型集成：内置网络协议，可对接几十种大模型，并且也支持AI绘画功能。
5. 强大的多媒体功能：支持AI翻译、PPT制作、语音克隆和翻唱等
6. 扩展功能：支持将大模型接入个人或企业微信
7. 支付功能：支持易支付、微信支付等多种支付方式

项目演示

后台管理

用户端

小程序端

开发前的配置要求

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-tenant              // 租户模块
│  └─ ruoyi-common-translation         // 通用翻译模块
│  └─ ruoyi-common-web                 // web模块
├─ ruoyi-modules                       // 模块组
│  └─ ruoyi-demo                       // 演示模块
│  └─ ruoyi-system                     // 业务模块
├─ .run                 // 执行脚本文件
├─ .editorconfig        // 编辑器编码格式配置
├─ LICENSE              // 开源协议
├─ pom.xml              // 公共依赖
├─ README.md            // 框架说明文件

使用到的框架

• Vben Admin
• Naive UI
• RuoYi-Vue-Plus

如何参与开源项目

贡献使开源社区成为一个学习、激励和创造的绝佳场所。你所作的任何贡献都是非常感谢的。

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参看当前可用版本。

进群学习

版权说明

该项目签署了MIT 授权许可，详情请参阅 LICENSE.txt

鸣谢

• chatgpt-java
• RuoYi-Vue-Plus
• chatgpt-web-midjourney-proxy