YX-SCM/yunxi-ui-admin-vben/README.md

# yudao-ui-admin-vben

[![license](https://img.shields.io/github/license/xingyuv/vue-vben-admin.svg)](LICENSE)

**严肃声明：现在、未来都不会有商业版本，所有代码全部开源!！**

**「我喜欢写代码，乐此不疲」**  
**「我喜欢做开源，以此为乐」**

如果这个项目让你有所收获，记得 Star 关注哦，这对我是非常不错的鼓励与支持。

## 预览地址

- [预览地址](http://dashboard-vben.yudao.iocoder.cn/)
- [启动文档](https://doc.iocoder.cn/quick-start/)
- [开发文档](http://vben-doc.x-surge.com/)
- [视频教程](https://doc.iocoder.cn/video/)

## 外包项目请联系 [ xinyu370 ]

- ![alt 定制开发](./public/resource/img/wx2.png)

## 交流群

- ![alt 交流群](./public/resource/img/wx.png)

## 框架

| 框架                                                                 | 说明                  | 版本   |
| -------------------------------------------------------------------- | --------------------- | ------ |
| [Vue](https://staging-cn.vuejs.org/)                                 | Vue 框架              | 3.3.4  |
| [Vite](https://cn.vitejs.dev//)                                      | 开发与构建工具        | 4.4.9  |
| [ant-design-vue](https://antdv.com/)                                 | ant-design-vue        | 4.0.3  |
| [TypeScript](https://www.typescriptlang.org/docs/)                   | JavaScript 的超集     | 5.1.6  |
| [pinia](https://pinia.vuejs.org/)                                    | Vue 存储库 替代 vuex5 | 2.1.6  |
| [vueuse](https://vueuse.org/)                                        | 常用工具集            | 10.4.1 |
| [vue-i18n](https://kazupon.github.io/vue-i18n/zh/introduction.html/) | 国际化                | 9.4.1  |
| [vue-router](https://router.vuejs.org/)                              | Vue 路由              | 4.2.5  |
| [unocss](https://uno.antfu.me/)                                      | 原子 css              | 0.56.1 |
| [iconify](https://icon-sets.iconify.design/)                         | 在线图标库            | 3.1.1  |

- ![alt VbenAdmin](https://anncwb.github.io/anncwb/images/preview1.png)
- ![alt VbenAdmin](https://anncwb.github.io/anncwb/images/preview2.png)
- ![alt VbenAdmin](https://anncwb.github.io/anncwb/images/preview3.png)

## 准备

- [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境
- [Vite4](https://vitejs.dev/) - 熟悉 vite 特性
- [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法
- [TypeScript](https://www.typescriptlang.org/) - 熟悉`TypeScript`基本语法
- [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法
- [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用
- [Ant-Design-Vue-4.0](https://antdv.com/) - ui 基本使用

## 安装使用

- 获取项目代码

```bash
git clone https://gitee.com/xingyuv/yudao-ui-admin-vben.git
or
git clone https://github.com/xingyuv/yudao-ui-admin-vben.git
```

- 安装依赖

```bash
pnpm i

如提示 Expected version: >=8.6.0

使用 cmd 等升级 pnpm 版本
npm add -g pnpm

```

- 运行

```bash
pnpm dev

or
// 如果不想启动后端

pnpm front

```

- 打包

```bash
pnpm build
```

## 开发进度

- 系统管理 已完成
- 基础设施 已完成
- 支付管理 已完成
- 升级 antdv 4.0 已完成
- 公众号 进行中 50% 预计年底
- 工作流 进行中 40% 预计年底

## Git 贡献提交规范

- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))

  - `feat` 增加新功能
  - `fix` 修复问题/BUG
  - `style` 代码风格相关无影响运行结果的
  - `perf` 优化/性能提升
  - `refactor` 重构
  - `revert` 撤销修改
  - `test` 测试相关
  - `docs` 文档/注释
  - `chore` 依赖更新/脚手架配置修改等
  - `workflow` 工作流改进
  - `ci` 持续集成
  - `types` 类型定义文件更改
  - `wip` 开发中

## 浏览器支持

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

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

| ![alt IE](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_32x32.png) | ![alt Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_32x32.png) | ![alt Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_32x32.png) | ![alt Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_32x32.png) | ![alt Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_32x32.png) |
| :---------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: |
|                     [IE](http://godban.github.io/browsers-support-badges/)                      |                     [Edge](http://godban.github.io/browsers-support-badgess/)                     |                        [Firefox](http://godban.github.io/browsers-support-badges/)                         |                       [Chrome](http://godban.github.io/browsers-support-badges/)                        |                       [Safari](http://godban.github.io/browsers-support-badges/)                        |
|                                           not support                                           |                                          last 2 versions                                          |                                              last 2 versions                                               |                                             last 2 versions                                             |                                             last 2 versions                                             |