ruoyi-plus-soybean/README.md

<div align="center">
	<img src="https://i.loli.net/2021/11/24/x5lLfuSnEawBAgi.png"/>
	<h1>Soybean Admin</h1>
</div>

[![license](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)

## 简介

Soybean Admin  是一个基于 Vue3、Vite、TypeScript、Naive UI 的免费中后台模版，它使用了最新的前端技术栈，内置丰富的主题配置，有着极高的代码规范，基于mock实现的动态权限路由，开箱即用的中后台前端解决方案，也可用于学习参考。

## 特性

- **最新技术栈**：使用 Vue3/vite2 等前端前沿技术开发, 使用高效率的npm包管理器pnpm
- **TypeScript**: 应用程序级 JavaScript 的语言
- **主题**：丰富可配置的主题、暗黑模式，基于windicss的动态主题颜色
- **代码规范**：丰富的规范插件及极高的代码规范
- **权限路由**：简易的路由配置、基于mock的动态路由能快速实现后端动态路由
- **请求函数**：基于axios的完善的请求函数封装

## 预览

- [soybean-admin](https://soybean.pro/)

## 文档

- [项目文档](https://docs.soybean.pro)

## 代码仓库

- [github](https://github.com/honghuangdc/soybean-admin)

- [gitee](https://gitee.com/honghuangdc/soybean-admin)

## 特性细节

- **技术栈**：Vite2 + Vue3 + TypeScript + NaiveUI + Pinia + WindiCss + Axios + AntV + @vueuse + iconify

- **严格的代码规范**：

  1. eslint + prettier + eslint-config-airbnb-base + eslint-plugin-vue + eslint-plugin-import + @typescript-eslint/eslint-plugin等插件提供代码全面的格式规范，eslintrc的 **import/order** 规则规范了导入依赖的顺序

  2. husky + lint-staged + vuetsc + commitlint + commitizen 保证了提交的代码符合eslint规则和TS类型检测，提交的内容规范遵循了angular提交规范
  3. 应用设计模式优化代码：项目里面多次用到策略模式替换if else
  4. 所有页面使用script-setup写法，并遵循特定顺序(用文档规范)
  5. 目录结构组织遵循特定规范，页面的写法严格遵循模块思想，使得每个页面的代码结构清晰明了

- **权限路由**：

  1. 动态的路由数据由mock生成，前端添加动态路由
  2. 指定了mock路由的类型，方便快速对接后端
  3. 菜单由动态路由数据生成，支持隐藏指定菜单，支持多级菜单，支持外链打开
  4. 在多页签中的缓存的页面会记录滚动位置
  5. 面包屑数据由当前路由和菜单数据生成

- **主题**：

  1. 支持各种主题颜色、暗黑模式和各种布局
  1. WindiCss引入各种主题颜色，直接通过class即可应用对应的颜色
  2. 初始化加载适应主题颜色
  3. 支持项目logo自适应主题颜色

- **请求函数**：基于axios封装

    1. 请求实例：可创建多个不同的baseUrl的请求实例

    2. 统一请求结果：将错误信息统一处理成特定格式，和请求成功的数据再按特定格式一起返回

       ```typescript
       interface ServiceResult<T> {
         data: T | null,
         error: ServiceError | null
       }
       ```

    3. 错误提示：智能提示错误，避免同一种错误在同一时间段显示，通过指定错误码不展示响应错误

    4. token刷新：无感刷新token

    5. 请求参数转换：根据不同的Content-Type转换数据，利用qs序列化数据，支持单文件和多文件上传

  6. 封装的请求函数支持promise和hooks两种, hooks的请求函数包含loading状态

- **自定义组件**

  1. 布局组件soybean-layout：
     - 分为header、tab、sider、content、footer五个部分，除了content，其余都可以控制显示隐藏，且可以自定义过度动画
     - 支持vertical和horizontal两种模式，结合局部的现实隐藏，为该项目提供了4种布局模式
     - 高性能组件，相比用UI组件构建的布局，该组件不用考虑很多因素，专注于当前的几种布局模式
  2. 多页签组件：ChromeTab和ButtonTab
     - 支持主题颜色及暗黑模式
     - ChromeTab类似于浏览器的标签，样式清新
     - 结合BetterScroll，实现多页签组件的左右鼠标滑动(移动端左右触摸滑动)，激活状态的Tab自动居中
  3. LoadingEmptyWrapper
     - 支持现实加载状态、空状态和网络状态的组件
     - 支持主题颜色及暗黑模式
     - 图片文字大小通过属性配置

## 项目示例图

![](https://s2.loli.net/2022/01/24/ovK6Oyqr7gIMu2n.png)

![](https://s2.loli.net/2022/01/24/O8loxYhMySHwGfJ.png)

![](https://s2.loli.net/2022/01/24/HKwpJ7Ab6j8fVvk.png)

![](https://s2.loli.net/2022/01/24/bqJRSDZHBv3jsif.png)

![](https://s2.loli.net/2022/01/24/wXpHeau6UrSTWdF.png)

![](https://s2.loli.net/2022/02/16/pBwF2gaxXnKZe3D.png)

![](https://s2.loli.net/2022/02/16/pfuxVEPsTJIXw5n.png)

## 安装使用

- 克隆代码

```bash
git clone https://github.com/honghuangdc/soybean-admin.git
```

- 安装依赖

```bash
pnpm i
```

- 运行

```bash
pnpm dev
```

- 打包

```bash
pnpm build
```

## 如何贡献

非常欢迎您的加入！[提一个 Issue](https://github.com/honghuangdc/soybean-admin/issues/new) 或者提交一个 Pull Request。

## Git 贡献提交规范

项目已经内置angular提交规范，通过git cz 代替git commit 命令即可。

git cz命令需要全局安装 commitizen

```bash
pnpm i -g commitizen
```

## 浏览器支持

本地开发推荐使用`Chrome 90+` 浏览器

支持现代浏览器, 不支持 IE

| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png" alt="IE" width="24px" height="24px"  />](http://godban.github.io/browsers-support-badges/)IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Safari |
| :-: | :-: | :-: | :-: | :-: |
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |

## 开源作者

[@Soybean](https://github.com/honghuangdc)

## 交流

`Soybean Admin` 是完全开源免费的项目，在帮助开发者更方便地进行中大型管理系统开发，同时也提供微信和QQ交流群，使用问题欢迎在群内提问。

- 微信交流群：
  <div style="text-align:left">
    <img src="https://s2.loli.net/2022/03/01/mvwx2URVBF9leT1.jpg" style="width:200px" />
  </div>

- QQ交流群 `711301266`

  <div style="text-align:left">
    <img src="https://i.loli.net/2021/11/24/1J6REWXiHomU2kM.jpg" style="width:200px" />
  </div>

- 本人微信号：honghuangdc，欢迎来技术交流，业务咨询。

## License

[MIT © Soybean-2021](./LICENSE)