ruoyi-element-ai/README.md
2025-06-07 00:39:51 +08:00

85 lines
4.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# ruoyi-element-ai
<div align="center">
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/element-plus-x/ruoyi-element-ai/blob/main/LICENSE)&emsp;[![Vue 3.5](https://img.shields.io/badge/Vue-3.5-4FC08D?logo=vue.js)](https://vuejs.org/)&emsp;[![Vite 5](https://img.shields.io/badge/Vite-5-646CFF?logo=vite)](https://vitejs.dev/)&emsp;[![TypeScript 5.8](https://img.shields.io/badge/TypeScript-5.8-3178C6?logo=typescript)](https://www.typescriptlang.org/)&emsp;[![GitHub Stars](https://img.shields.io/github/stars/element-plus-x/ruoyi-element-ai?style=social)](https://github.com/element-plus-x/ruoyi-element-ai)&emsp;
</div>
## 🚀 项目亮点
**ruoyi-element-ai** 是基于 **Vue3.5** + **Element-Plus-X** + **TypeScript** 的企业级AI应用模板搭配 **ruoyi-ai** 后端,快速构建仿豆包/通义的全栈AI项目。
## 💡 核心优势
- 最新技术栈Vue3.5/Vite5/Pinia3/TypeScript5.8
- 流式交互Hook-Fetch支持Server-Sent Events
- 企业级规范ESLint/Stylelint/husky/commitlint全链路校验
- 开箱即用:内置动态路由、状态管理、组件库封装
<div align="center">
<img src="https://cdn.element-plus-x.com/chat/1.webp" calss="element-plus-x-bubble" />
</div>
## 🔗 关键链接
| 功能模块 | 说明 | 链接 |
|------------------|-------------------------------|----------------------------------------------------------------------|
| 🚀 前端仓库 | Gitee/GitHub 代码仓库(感谢 star🥰爱你爱你😘) | [Gitee](https://gitee.com/he-jiayue/ruoyi-element-ai) <br> [GitHub](https://github.com/element-plus-x/ruoyi-element-ai) |
| 🛠️ 后端仓库 | 待补充支持Java/Node | 待更新 |
| 📚 前端文档 | 开发指南/组件说明 | [快速了解项目](https://chat-docs.element-plus-x.com) |
| 📡 在线演示 | 实时交互体验 | [立即访问](https://chat.element-plus-x.com) |
## 🧰 核心功能
- 使用 Vue3.5+ 各种新特性的支持,让开发更有效率
- 采用 Vite6.3+ 作为项目开发、打包工具
- 使用 Pinia3.0+ 作为全局状态管理库,轻量、优雅、易用,集成 Pinia 持久化插件
- 使用 TypeScript5.8+ 增强项目的代码规范和可读性
- 使用 Unocss 预设样式,更快书写简单的样式
- 弃用 Axios (不支持流式请求) 改用 Hook-Fetch (支持流模式,插件化封装,写法极度优雅) 进行全局的请求封装
- 使用 VueRouter 配置动态路由权限拦截、路由懒加载
- 使用 KeepAlive 对页面进行缓存
- 封装了一些好用的组件和Hooks增强用户交互体验
- 使用 ESLint9+、Stylelint16+ 代码校验规范、同时统一保存格式化代码
- 使用 husky、lint-staged、commitlint、cz-git 规范提交信息
## 📦 安装与运行
```bash
# 克隆项目
# Gitee
git clone https://gitee.com/he-jiayue/ruoyi-element-ai.git
# GitHub
git clone https://github.com/element-plus-x/ruoyi-element-ai.git
cd ruoyi-element-ai
# 安装依赖推荐pnpm 避免幻影依赖)
pnpm install
# 开发模式
pnpm run dev
# 生产构建
pnpm build
# 代码校验
pnpm lint # ESLint检测
pnpm lint:stylelint # 样式格式化
pnpm cz # 规范提交自动执行lint
```
## 🤝 社区支持
| 👨‍👨‍👧‍👦 微信交流群 | 💩 作者微信 |
|---------------------------------------|-------------------------------------|
| <img src="https://cdn.element-plus-x.com/vx-2025-06-06.png" alt="微信交流群" width="230px"><br>扫码加入交流群<br>获取最新动态与技术支持 | <img src="https://cdn.element-plus-x.com/vx.png" alt="作者vx" width="230px" ><br>群过期或失效?<br>扫码添加作者微信 |
## 🌹 赠人玫瑰,手有余香
<div align="center">
<p>😍开源是热爱的坚持,您的每一份心意都让我们走得更远~😍</p>
<img src="https://cdn.element-plus-x.com/zs5.png" alt="赞赏" width="180" height="100%" />
<h3 style="color: #fa8c16; margin-bottom: 10px;">🙊感谢您的支持!🙊</h3>
<p style="color: #666; margin: 15px 0;">💖感谢每一份温暖助力💖</p>
<p style="color: #666; margin: 15px 0;">💌 扫码赞赏,后续将截图保留,并公示赞赏记录 💌</p>
</div>
</div>