vue-pure-admin2/README.md

160 lines
8.2 KiB
Markdown
Raw Normal View History

2021-04-13 18:37:47 +08:00
<h1>vue-pure-admin</h1>
2021-03-01 15:26:05 +08:00
2023-02-08 18:07:05 +08:00
![GitHub license](https://img.shields.io/github/license/pure-admin/vue-pure-admin?style=flat)
![GitHub stars](https://img.shields.io/github/stars/pure-admin/vue-pure-admin?color=fa6470&style=flat)
![GitHub forks](https://img.shields.io/github/forks/pure-admin/vue-pure-admin?style=flat)
2021-04-13 18:37:47 +08:00
**中文** | [English](./README.en-US.md)
2021-04-13 18:37:47 +08:00
## 简介
2021-04-13 18:37:47 +08:00
2022-11-08 00:48:16 +08:00
`vue-pure-admin` 是一款开源免费且开箱即用的中后台管理系统模版。使用了最新的 `Vue3`、`Vite`、`Element-Plus`、`TypeScript`、`Pinia`、`Tailwindcss` 等主流技术开发
2021-04-13 18:37:47 +08:00
2022-11-27 18:14:44 +08:00
## 精简版(实际项目开发请用精简版,提供 `非国际化` 、`国际化` 两个版本选择)
2023-02-08 18:07:05 +08:00
精简版是基于 [vue-pure-admin](https://github.com/pure-admin/vue-pure-admin) 提炼出的架子,包含主体功能,更适合实际项目开发,打包后的大小在全局引入 [element-plus](https://element-plus.org) 的情况下仍然低于 `2.3MB`,并且会永久同步完整版的代码。开启 `brotli` 压缩和 `cdn` 替换本地库模式后,打包大小低于 `350kb`
2022-11-27 18:14:44 +08:00
2023-02-08 18:07:05 +08:00
- [点我查看非国际化精简版](https://github.com/pure-admin/pure-admin-thin)
- [点我查看国际化精简版](https://github.com/pure-admin/pure-admin-thin/tree/i18n)
2022-11-27 18:14:44 +08:00
2021-11-14 08:46:43 +08:00
## 配套视频
2021-10-18 22:04:57 +08:00
2022-11-18 22:40:32 +08:00
- [点我查看快速开发教程](https://www.bilibili.com/video/BV1kg411v7QT)
2022-01-09 18:44:23 +08:00
- [点我查看 UI 设计](https://www.bilibili.com/video/BV17g411T7rq)
2021-10-18 22:04:57 +08:00
2023-05-22 16:40:13 +08:00
## 配套保姆级文档
2021-11-20 19:47:28 +08:00
2022-11-08 00:48:16 +08:00
- [点我查看国内文档站](https://yiming_chang.gitee.io/pure-admin-doc)
2023-02-08 18:07:05 +08:00
- [点我查看国外文档站](https://pure-admin.github.io/pure-admin-doc)
2021-11-20 19:47:28 +08:00
2022-11-22 11:15:50 +08:00
## `Tauri` 版
2022-04-19 15:31:08 +08:00
2023-02-08 18:07:05 +08:00
- [点我查看 Tauri 版](https://github.com/pure-admin/tauri-pure-admin)
2022-04-19 15:31:08 +08:00
2022-11-22 11:15:50 +08:00
## `Electron` 版
2022-11-14 12:09:10 +08:00
2023-02-08 18:07:05 +08:00
- [点我查看 Electron 版](https://github.com/pure-admin/electron-pure-admin)
2022-11-14 12:09:10 +08:00
## 预览
2021-04-13 18:37:47 +08:00
2022-11-08 00:48:16 +08:00
- [点我查看国内预览站](https://yiming_chang.gitee.io/vue-pure-admin)
2023-02-08 18:07:05 +08:00
- [点我查看国外预览站](https://pure-admin.github.io/vue-pure-admin)
2021-04-13 18:37:47 +08:00
2022-08-18 00:20:04 +08:00
- PC 端
2021-04-13 18:37:47 +08:00
<p align="center">
2022-08-18 00:20:04 +08:00
<img alt="PureAdmin Logo" width="100%" src="https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/d45c15ccbe674fe291a4faa528d11eda~tplv-k3u1fbpfcp-zoom-in-crop-mark:3024:0:0:0.awebp?">
</p>
- 暗黑模式
<p align="center">
<img alt="PureAdmin Logo" width="100%" src="https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/10a351f0d9c94b90ba3b408a786b9ede~tplv-k3u1fbpfcp-zoom-in-crop-mark:3024:0:0:0.awebp?">
</p>
- 移动端
<p align="center">
<img alt="PureAdmin Logo" width="100%" src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/3061c7b92f6d4cb4bcdf227d966ac696~tplv-k3u1fbpfcp-zoom-in-crop-mark:3024:0:0:0.awebp?">
2021-04-13 18:37:47 +08:00
</p>
2022-11-22 11:15:50 +08:00
### 使用 `Gitpod`
2021-04-13 18:37:47 +08:00
在 Gitpod适用于 GitHub 的免费在线开发环境)中打开项目,并立即开始编码.
2021-04-13 18:37:47 +08:00
2023-02-08 18:07:05 +08:00
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/pure-admin/vue-pure-admin)
2021-04-13 18:37:47 +08:00
## 安装使用
2021-04-13 18:37:47 +08:00
- 获取项目代码
2021-04-13 18:37:47 +08:00
```bash
2023-02-08 18:07:05 +08:00
git clone https://github.com/pure-admin/vue-pure-admin.git
2021-04-13 18:37:47 +08:00
or
2022-02-18 16:12:40 +08:00
git clone https://gitee.com/yiming_chang/vue-pure-admin.git
2021-03-01 15:06:11 +08:00
```
2021-04-13 18:37:47 +08:00
- 安装依赖
2021-04-13 18:37:47 +08:00
```bash
cd vue-pure-admin
2021-11-03 14:16:34 +08:00
pnpm install
2021-04-13 18:37:47 +08:00
2021-03-01 15:06:11 +08:00
```
- 运行
2021-03-01 15:26:05 +08:00
2021-04-13 18:37:47 +08:00
```bash
2021-11-03 14:16:34 +08:00
pnpm serve
2021-03-01 15:06:11 +08:00
```
2020-11-16 14:10:17 +08:00
- 打包
2021-03-01 15:26:05 +08:00
2021-04-13 18:37:47 +08:00
```bash
2021-11-03 14:16:34 +08:00
pnpm build
2021-03-01 15:06:11 +08:00
```
2021-03-01 15:26:05 +08:00
## 更新日志
2021-03-01 15:26:05 +08:00
[CHANGELOG](./CHANGELOG.zh_CN.md)
2021-03-01 15:26:05 +08:00
## 如何贡献
2021-04-13 18:37:47 +08:00
2023-02-08 18:07:05 +08:00
非常欢迎您的加入![提一个 Issue](https://github.com/pure-admin/vue-pure-admin/issues/new/choose) 或者提交一个 `Pull Request`
2021-04-13 18:37:47 +08:00
**Pull Request:**
1. Fork 代码!
2. 创建自己的分支: `git checkout -b feat/xxxx`
2022-11-22 11:15:50 +08:00
3. 提交您的修改: `git commit -am 'feat(function): add xxxxx'`
4. 推送您的分支: `git push origin feat/xxxx`
5. 提交`pull request`
2021-04-13 18:37:47 +08:00
2022-11-22 11:15:50 +08:00
## `Git` 贡献提交规范
2021-04-13 18:37:47 +08:00
- 参考 [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))
2021-04-13 18:37:47 +08:00
- `feat` 增加新功能
- `fix` 修复问题/BUG
- `style` 代码风格相关无影响运行结果的
- `perf` 优化/性能提升
- `refactor` 重构
- `revert` 撤销修改
- `test` 测试相关
- `docs` 文档/注释
- `chore` 依赖更新/脚手架配置修改等
- `workflow` 工作流改进
- `ci` 持续集成
- `types` 类型定义文件更改
- `wip` 开发中
2021-04-13 18:37:47 +08:00
## 浏览器支持
2021-04-13 18:37:47 +08:00
2022-11-22 11:15:50 +08:00
本地开发推荐使用 `Chrome 80+` 浏览器
2021-04-13 18:37:47 +08:00
2022-11-22 11:15:50 +08:00
支持现代浏览器, 不支持 `IE`
2021-04-13 18:37:47 +08:00
| [<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>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 |
2021-04-24 00:45:00 +08:00
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
2021-04-13 18:37:47 +08:00
## 维护者
2021-04-13 18:37:47 +08:00
2022-04-18 12:55:44 +08:00
[xiaoxian521](https://github.com/xiaoxian521)、[Ten-K](https://github.com/Ten-K)
2021-04-13 18:37:47 +08:00
2021-10-21 09:51:01 +08:00
## 许可证
2021-03-01 15:26:05 +08:00
2023-05-22 16:40:13 +08:00
原则上不收取任何费用及版权,可商用,不过如需二次开源(比如用此平台二次开发并开源,要求前端代码必须开源免费)请联系作者获取许可!(免费,走个记录而已)
2021-10-22 17:49:48 +08:00
2023-05-01 12:42:01 +08:00
[MIT © 2020-present, pure-admin](./LICENSE)
2021-10-21 09:51:01 +08:00
2022-11-22 11:15:50 +08:00
## `Star`
非常感谢留下星星的好心人,感谢您的支持 :heart:
2023-02-08 18:07:05 +08:00
[![Stargazers for vue-pure-admin](https://reporoster.com/stars/pure-admin/vue-pure-admin)](https://github.com/pure-admin/vue-pure-admin/stargazers)
2022-11-22 11:52:10 +08:00
## `Fork`
瞧,那些 `小哥哥` 、`小姐姐` 认真 `学习` 的样子真滴是 `哎呦不错哦` :heart:
2023-02-08 18:07:05 +08:00
[![Forkers repo roster for vue-pure-admin](https://reporoster.com/forks/pure-admin/vue-pure-admin)](https://github.com/pure-admin/vue-pure-admin/network/members)