yudao
/
admin-vben
mirror of https://gitee.com/yudaocode/yudao-ui-admin-vben.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

【优化】README.md 说明

pull/42/head
YunaiV 2024-05-04 11:45:38 +08:00
parent 699d1de0d3
commit 97dd360d97
1 changed files with 20 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
README.md
View File

@ -9,36 +9,35 @@
## 预览地址 ## 预览地址
- [预览地址](http://dashboard-vben.yudao.iocoder.cn/) ![预览](./public/resource/img/preview.png)
- [启动文档](https://doc.iocoder.cn/quick-start/)
- [开发文档](https://doc.vvbin.cn/)
- [视频教程](https://doc.iocoder.cn/video/)
## 外包项目请联系 [ xinyu370 ] - 预览地址：<http://dashboard-vben.yudao.iocoder.cn/>
- 启动文档：<https://doc.iocoder.cn/quick-start/>
- 开发文档：<https://doc.vvbin.cn/>
- 视频教程：<https://doc.iocoder.cn/video/>
- 交流群：<https://doc.iocoder.cn/qun/>
- ![alt 定制开发](./public/resource/img/wx2.png) ## 外包项目请联系
## 交流群 微信号：xinyu370
- ![alt 交流群](./public/resource/img/wx.png) ![alt 定制开发](./public/resource/img/wx2.png)
## 框架 ## 框架
| 框架 | 说明 | 版本 | | 框架 | 说明 | 版本 |
| -------------------------------------------------------------------- | --------------------- | ------ | |----------------------------------------------------------------------|------------------|--------|
| [Vue](https://staging-cn.vuejs.org/) | Vue 框架 | 3.3.8 | | [Vue](https://staging-cn.vuejs.org/) | Vue 框架 | 3.3.8 |
| [Vite](https://cn.vitejs.dev//) | 开发与构建工具 | 4.5.0 | | [Vite](https://cn.vitejs.dev//) | 开发与构建工具 | 4.5.0 |
| [ant-design-vue](https://antdv.com/) | ant-design-vue | 4.0.7 | | [ant-design-vue](https://antdv.com/) | ant-design-vue | 4.0.7 |
| [TypeScript](https://www.typescriptlang.org/docs/) | JavaScript 的超集 | 5.2.2 | | [TypeScript](https://www.typescriptlang.org/docs/) | JavaScript 的超集 | 5.2.2 |
| [pinia](https://pinia.vuejs.org/) | Vue 存储库 替代 vuex5 | 2.1.7 | | [pinia](https://pinia.vuejs.org/) | Vue 存储库 替代 vuex5 | 2.1.7 |
| [vueuse](https://vueuse.org/) | 常用工具集 | 10.6.0 | | [vueuse](https://vueuse.org/) | 常用工具集 | 10.6.0 |
| [vue-i18n](https://kazupon.github.io/vue-i18n/zh/introduction.html/) | 国际化 | 9.6.5 | | [vue-i18n](https://kazupon.github.io/vue-i18n/zh/introduction.html/) | 国际化 | 9.6.5 |
| [vue-router](https://router.vuejs.org/) | Vue 路由 | 4.2.5 | | [vue-router](https://router.vuejs.org/) | Vue 路由 | 4.2.5 |
| [unocss](https://uno.antfu.me/) | 原子 css | 0.57.3 | | [unocss](https://uno.antfu.me/) | 原子 css | 0.57.3 |
| [iconify](https://icon-sets.iconify.design/) | 在线图标库 | 3.1.1 | | [iconify](https://icon-sets.iconify.design/) | 在线图标库 | 3.1.1 |
- ![alt Admin](./public/resource/img/preview.png)
## 准备 ## 准备
- [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境 - [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境
@ -49,46 +48,6 @@
- [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用 - [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用
- [Ant-Design-Vue-4.0](https://antdv.com/) - ui 基本使用 - [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.9.0
使用 cmd 等升级 pnpm 版本
npm add -g pnpm
```
- 运行
```bash
pnpm dev
or
// 如果不想启动后端
pnpm front
```
- 打包
```bash
pnpm build
```
## Git 贡献提交规范 ## 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)) - 参考 [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))
@ -109,11 +68,11 @@ pnpm build
## 浏览器支持 ## 浏览器支持
本地开发推荐使用`Chrome 80+` 浏览器 本地开发推荐使用 `Chrome 80+` 浏览器
支持现代浏览器, 不支持 IE 支持现代浏览器, 不支持 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) | | ![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/) | | [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 | | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |