vue-pure-admin2/README.md

158 lines
11 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
2022-01-09 18:44:23 +08:00
![GitHub license](https://img.shields.io/github/license/xiaoxian521/vue-pure-admin?style=flat)
![GitHub stars](https://img.shields.io/github/stars/xiaoxian521/vue-pure-admin?color=fa6470&style=flat)
![GitHub forks](https://img.shields.io/github/forks/xiaoxian521/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
2021-10-22 17:52:38 +08:00
vue-pure-admin 是一个免费开源的中后台模版。使用了最新的`vue3` `vite2` `Element-Plus` `TypeScript`等主流技术开发,开箱即用的中后台前端解决方案,也可用于学习参考。
2021-04-13 18:37:47 +08:00
2021-11-14 08:46:43 +08:00
## 配套视频
2021-10-18 22:04:57 +08:00
2022-01-09 18:44:23 +08:00
- [点我查看教程](https://www.bilibili.com/video/BV1534y1S7HV)
- [点我查看 UI 设计](https://www.bilibili.com/video/BV17g411T7rq)
2021-10-18 22:04:57 +08:00
2021-11-20 19:47:28 +08:00
## 配套文档
2022-01-09 18:44:23 +08:00
- [点我查看文档](https://pure-admin-doc.vercel.app)
2021-11-20 19:47:28 +08:00
2021-11-14 09:15:20 +08:00
## 精简版
2022-01-09 18:44:23 +08:00
- [点我查看精简版](https://github.com/xiaoxian521/pure-admin-thin)
2021-11-14 09:15:20 +08:00
2022-04-19 15:31:08 +08:00
## Tauri 版
- [点我查看 Tauri 版](https://github.com/xiaoxian521/tauri-pure-admin)
## 预览
2021-04-13 18:37:47 +08:00
2022-02-15 15:22:48 +08:00
- [vue-pure-admin](https://vue-pure-admin.vercel.app)
2021-04-13 18:37:47 +08:00
<p align="center">
2021-11-10 20:40:06 +08:00
<img alt="PureAdmin Logo" width="100%" src="https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/b4857fc7eb7d4c0f8deeefc644c1f7dd~tplv-k3u1fbpfcp-watermark.awebp?">
<img alt="PureAdmin Logo" width="100%" src="https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/549c3184697f4d268a78c9833e5ec2ea~tplv-k3u1fbpfcp-watermark.awebp?">
2021-12-20 16:10:36 +08:00
<img alt="PureAdmin Logo" width="100%" src="https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/381fc957fac143db9f06efdd389d88a3~tplv-k3u1fbpfcp-watermark.awebp?">
2021-04-13 18:37:47 +08:00
</p>
### 使用 Gitpod
2021-04-13 18:37:47 +08:00
在 Gitpod适用于 GitHub 的免费在线开发环境)中打开项目,并立即开始编码.
2021-04-13 18:37:47 +08:00
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/xiaoxian521/vue-pure-admin)
## 安装使用
2021-04-13 18:37:47 +08:00
- 获取项目代码
2021-04-13 18:37:47 +08:00
```bash
git clone https://github.com/xiaoxian521/vue-pure-admin.git
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
非常欢迎你的加入![提一个 Issue](https://github.com/xiaoxian521/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`
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
## 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
本地开发推荐使用`Chrome 80+` 浏览器
2021-04-13 18:37:47 +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-04-13 18:37:47 +08:00
2022-03-07 20:43:27 +08:00
如果你觉得这个项目对您有帮助,可以帮作者买一杯果汁 🍹 表示支持
2021-04-13 18:37:47 +08:00
2022-03-07 20:43:27 +08:00
<img src="https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f69bf13c5b854ed5b699807cafa0e3ce~tplv-k3u1fbpfcp-zoom-in-crop-mark:1304:0:0:0.awebp?" width="150px" height="150px" />
2021-04-13 18:37:47 +08:00
2022-02-10 13:13:38 +08:00
## QQ 交流群
2022-07-10 23:26:15 +08:00
一群已满,下面是二群,群里严禁`黄`、`赌`、`毒`、`vpn`等违法行为!
2022-02-10 13:13:38 +08:00
2022-07-10 23:26:15 +08:00
<img src="https://pure-admin-doc.vercel.app/img/support/qq.png" width="150px" height="225px" />
2022-02-10 13:13:38 +08:00
2021-10-21 09:51:01 +08:00
## 许可证
2021-03-01 15:26:05 +08:00
原则上不收取任何费用及版权,可以放心使用,不过如需二次开源(比如用此平台二次开发并开源)请联系作者获取许可!
2021-10-22 17:49:48 +08:00
2021-04-13 18:37:47 +08:00
[MIT © xiaoxian521-2020](./LICENSE)
2021-10-21 09:51:01 +08:00
2021-10-21 10:39:21 +08:00
## 捐赠者
2021-10-21 09:51:01 +08:00
非常感谢你们的支持,相信项目会越来越好 :heart:
2021-10-21 10:35:16 +08:00
2022-07-04 19:55:15 +08:00
| xueyuheng | taolei1990 | hang-kim | madwolfcrazy | limuen | BenLakes |
| :--------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: |
| <a href="https://github.com/xueyuheng"><img src="https://avatars.githubusercontent.com/u/48202935?v=4" width="60px" height="60px" /></a> | <a href="https://github.com/taolei1990"><img src="https://avatars.githubusercontent.com/u/23173640?v=4" width="60px" height="60px" /></a> | <a href="https://github.com/hang-kim"><img src="https://avatars.githubusercontent.com/u/52914259?v=4" width="60px" height="60px" /></a> | <a href="https://github.com/madwolfcrazy"><img src="https://avatars.githubusercontent.com/u/223671?v=4" width="60px" height="60px" /></a> | <a href="https://github.com/limuen"><img src="https://avatars.githubusercontent.com/u/31790606?v=4" width="60px" height="60px" /></a> | <a href="https://github.com/BenLakes"><img src="https://avatars.githubusercontent.com/u/15206046?v=4" width="60px" height="60px" /></a> |
| mollerzhu | TLovers | cnyyk | | | |
2022-07-10 23:26:15 +08:00
| <a href="https://github.com/mollerzhu"><img src="https://avatars.githubusercontent.com/u/49627902?v=4" width="60px" height="60px" /></a> | <a href="https://github.com/TLovers"><img src="https://avatars.githubusercontent.com/u/26561694?v=4" width="60px" height="60px" /></a> | <a href="https://github.com/cnyyk"><img src="https://avatars.githubusercontent.com/u/275233?v=4" width="60px" height="60px" /></a> | | | |
2021-10-21 09:51:01 +08:00
## 贡献者
这个项目的存在感谢所有做出贡献的人 :heart:
2021-10-22 17:49:48 +08:00
2021-10-21 09:51:01 +08:00
<a href="https://github.com/xiaoxian521/vue-pure-admin/graphs/contributors"><img src="https://contrib.rocks/image?repo=xiaoxian521/vue-pure-admin" /></a>