FlowPacs/yudao-ui-admin-vue3/README.md

117 lines
4.7 KiB
Markdown
Raw Normal View History

2022-07-18 19:06:37 +08:00
<h1>🌈 yudao-ui-admin-vue3</h1>
<p align="center">
<img src="https://img.shields.io/badge/-Vue3.2-34495e?logo=vue.j" />
<img src="https://img.shields.io/badge/-Vite3-646cff?logo=vite&logoColor=white" />
2022-10-19 10:42:37 +08:00
<img src="https://img.shields.io/badge/-TypeScript4.8-blue?logo=typescript&logoColor=white" />
<img src="https://img.shields.io/badge/-Pinia2-yellow?logo=picpay&logoColor=white" />
<img src="https://img.shields.io/badge/-ESLint-4b32c3?logo=eslint&logoColor=white" />
<img src="https://img.shields.io/badge/-pnpm7-F69220?logo=pnpm&logoColor=white" />
<img src="https://img.shields.io/badge/-Axios-008fc7?logo=axios.js&logoColor=white" />
<img src="https://img.shields.io/badge/-Prettier-ef9421?logo=Prettier&logoColor=white" alt="Prettier">
<img src="https://img.shields.io/badge/-Less-1D365D?logo=less&logoColor=white" alt="Less">
<img src="https://img.shields.io/badge/-Wind%20CSS-06B6D4?logo=Tailwind%20CSS&logoColor=white" alt="Taiwind">
</p>
2022-07-18 19:06:37 +08:00
## 介绍
- 基于 vue3.2+ TypeScript Element Plus 2.2.0+ Vite3 Pinia Windicss 等开发的后台管理系统
## 注意事项
- 项目路径请不要使用中文命名!!!会造成解析乱码!!!请使用全英文路径!!!
2022-07-20 15:26:53 +08:00
- node >=14.18.0(建议使用 16 版本) ,pnpm >=7
2022-07-18 19:06:37 +08:00
- 开发建议使用 [谷歌浏览器-开发者版](https://www.google.cn/intl/zh-CN/chrome/dev/) 不支持 IE\QQ 等浏览器
2022-08-02 11:37:55 +08:00
### 点击查看[使用说明](./use.md)
2022-07-18 19:06:37 +08:00
### 前端依赖
| 框架 | 说明 | 版本 |
| --- | --- |--------|
2022-10-17 13:02:23 +08:00
| [Vue](https://staging-cn.vuejs.org/) | vue 框架 | 3.2.41 |
| [Vite](https://cn.vitejs.dev//) | 开发与构建工具 | 3.1.8 |
| [Element Plus](https://element-plus.org/zh-CN/) | Element Plus | 2.2.18 |
2022-10-11 14:10:13 +08:00
| [TypeScript](https://www.typescriptlang.org/docs/) | JavaScript 的超集 | 4.8.4 |
| [pinia](https://pinia.vuejs.org/) | Vue 存储库 替代 vuex5 | 2.0.23 |
2022-10-17 13:02:23 +08:00
| [vueuse](https://vueuse.org//) | 常用工具集 | 9.3.1 |
2022-10-11 14:10:13 +08:00
| [vue-i18n](https://kazupon.github.io/vue-i18n/zh/introduction.html/) | 国际化 | 9.2.2 |
| [vue-router](https://router.vuejs.org/) | vue 路由 | 4.1.5 |
2022-08-01 19:29:22 +08:00
| [windicss](https://cn.windicss.org/) | 下一代工具优先的 CSS 框架 | 3.5.6 |
2022-10-11 14:10:13 +08:00
| [iconify](https://icon-sets.iconify.design/) | 在线图标库 | 3.0.0 |
| [wangeditor](https://www.wangeditor.com/) | 富文本编辑器 | 5.1.21 |
2022-07-18 19:06:37 +08:00
### 推荐 VScode 开发,插件如下
- WindiCSS IntelliSense WindiCSS --- 自动完成、语法突出显示、代码折叠和构建等高级功能
- TypeScript Vue Plugin (Volar) --- 用于 TypeScript 的 Vue 插件
- Vue Language Features (Volar) --- Vue3.0 语法支持
- Iconify IntelliSense --- Iconify 预览和搜索
- i18n Ally --- 国际化智能提示
- Stylelint --- css 格式化
- DotENV --- .env 文件高亮
- Prettier --- 代码格式化
- ESLint --- 脚本代码检查
### 安装 pnpm 并启动项目
2022-07-20 15:26:53 +08:00
- 查看当前 npm 源
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
```bash
2022-07-18 19:06:37 +08:00
npm config ls
2022-07-20 15:26:53 +08:00
```
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
- 如果执行上面命令您并未看到 registry = "https://registry.npmjs.org/"说明使用的非npm官方源请执行下面命令
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
```bash
2022-07-18 19:06:37 +08:00
npm config set registry https://registry.npmjs.org
2022-07-20 15:26:53 +08:00
```
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
- 如果您还没安装 pnpm请执行下面命令
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
```bash
2022-07-18 19:06:37 +08:00
npm install -g pnpm
2022-07-20 15:26:53 +08:00
```
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
- mac 用户遇到安装报错请在命令前加上 sudo
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
- 安装依赖
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
```bash
2022-07-18 19:06:37 +08:00
pnpm install
2022-07-20 15:26:53 +08:00
```
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
- 运行项目
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
```bash
2022-07-18 19:06:37 +08:00
pnpm run dev
2022-07-20 15:26:53 +08:00
```
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
- 打包
2022-07-19 18:23:13 +08:00
2022-07-20 15:26:53 +08:00
```bash
2022-07-19 18:23:13 +08:00
pnpm run build:pro
2022-07-20 15:26:53 +08:00
```
2022-07-19 18:23:13 +08:00
2022-07-20 15:26:53 +08:00
- 安装一个包
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
```bash
2022-07-18 19:06:37 +08:00
pnpm add 包名
2022-07-20 15:26:53 +08:00
```
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
- 卸载一个包
2022-07-18 19:06:37 +08:00
2022-07-20 15:26:53 +08:00
```bash
2022-07-18 19:06:37 +08:00
pnpm remove 包名
```
2022-07-20 15:26:53 +08:00
- 其他命令请看 package.json
2022-07-18 19:06:37 +08:00
## 浏览器支持
本地开发推荐使用 `Chrome 80+` 浏览器
支持现代浏览器, 不支持 IE ,QQ 等
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>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/)</br>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/)</br>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/)</br>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/)</br>Safari |
| :-: | :-: | :-: | :-: | :-: |
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |