vue-pure-admin2/README.en-US.md

152 lines
9.5 KiB
Markdown
Raw Normal View History

2021-04-13 18:37:47 +08:00
<h1>vue-pure-admin</h1>
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.md)
2021-04-13 18:37:47 +08:00
## Introduction
2021-04-13 18:37:47 +08:00
2021-10-22 17:52:38 +08:00
vue-pure-admin is a free and open source middle and back-end template. Using the latest `vue3` `vite2` `Element-Plus` `TypeScript` and other mainstream technology development, the out-of-the-box middle and back-end front-end solutions can also be used for learning reference.
2021-04-13 18:37:47 +08:00
2021-11-14 08:46:43 +08:00
## Supporting Video
2021-10-18 22:04:57 +08:00
2022-01-09 18:44:23 +08:00
- [Click Watch Tutorial](https://www.bilibili.com/video/BV1534y1S7HV)
- [Click Watch UI Design](https://www.bilibili.com/video/BV17g411T7rq)
2021-10-18 22:04:57 +08:00
2021-11-28 23:43:52 +08:00
## Docs
2022-01-09 18:44:23 +08:00
- [Click Watch Docs](https://pure-admin-doc.vercel.app)
2021-11-28 23:43:52 +08:00
2021-11-14 09:15:20 +08:00
## Thin
2022-01-09 18:44:23 +08:00
- [Click Watch Thin](https://github.com/xiaoxian521/pure-admin-thin)
2021-11-14 09:15:20 +08:00
## Preview
2021-04-13 18:37:47 +08:00
2021-04-24 00:45:00 +08:00
- [vue-pure-admin](http://yiming_chang.gitee.io/manages)
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>
### Use Gitpod
2021-04-13 18:37:47 +08:00
Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately.
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)
## Install and use
2021-04-13 18:37:47 +08:00
- Get the project code
2021-04-13 18:37:47 +08:00
```bash
git clone https://github.com/xiaoxian521/vue-pure-admin.git
or
git clone https://github.com.cnpmjs.org/xiaoxian521/vue-pure-admin.git
```
- Installation dependencies
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
```
- run
2021-04-13 18:37:47 +08:00
```bash
2021-11-03 14:16:34 +08:00
pnpm serve
2021-04-13 18:37:47 +08:00
```
- build
2021-04-13 18:37:47 +08:00
```bash
2021-11-03 14:16:34 +08:00
pnpm build
2021-04-13 18:37:47 +08:00
```
## Change Log
2021-04-13 18:37:47 +08:00
[CHANGELOG](./CHANGELOG.en_US.md)
2021-04-13 18:37:47 +08:00
## How to contribute
2021-04-13 18:37:47 +08:00
You are very welcome to join[Raise an issue](https://github.com/xiaoxian521/vue-pure-admin/issues/new/choose) Or submit a Pull Request
2021-04-13 18:37:47 +08:00
**Pull Request:**
1. Fork code!
2. Create your own branch: `git checkout -b feat/xxxx`
3. Submit your changes: `git commit -am 'feat(function): add xxxxx'`
4. Push your branch: `git push origin feat/xxxx`
5. submit`pull request`
2021-04-13 18:37:47 +08:00
## Git Contribution submission specification
2021-04-13 18:37:47 +08:00
- reference [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
2021-04-13 18:37:47 +08:00
- `feat` Add new features
- `fix` Fix the problem/BUG
- `style` The code style is related and does not affect the running result
- `perf` Optimization/performance improvement
- `refactor` Refactor
- `revert` Undo edit
- `test` Test related
- `docs` Documentation/notes
- `chore` Dependency update/scaffolding configuration modification etc.
- `workflow` Workflow improvements
- `ci` Continuous integration
- `types` Type definition file changes
- `wip` In development
2021-04-13 18:37:47 +08:00
## Browser support
2021-04-13 18:37:47 +08:00
The `Chrome 80+` browser is recommended for local development
2021-04-13 18:37:47 +08:00
Support modern browsers, not 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
## Maintainer
2021-04-13 18:37:47 +08:00
[xiaoxian521](https://github.com/xiaoxian521)
## Donate
2021-04-13 18:37:47 +08:00
2021-12-28 13:21:16 +08:00
If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support
2021-04-13 18:37:47 +08:00
2021-12-28 13:21:16 +08:00
<img src="http://yiming_chang.gitee.io/manages/pay.jpg" width="150px" height="150px" />
## WeChat Exchange Group
For the better development of the project, you can choose to donate 10 yuan and add the following WeChat to pull you into the group. After adding, please consciously send a screenshot of the donation
2021-12-28 15:09:17 +08:00
<img src="http://yiming_chang.gitee.io/manages/kf.jpg" width="150px" height="195px" />
2021-04-13 18:37:47 +08:00
## License
2021-10-22 17:49:48 +08:00
In principle, no fees and copyrights are charged, so you can use it with confidence
2021-04-13 18:37:47 +08:00
[MIT © xiaoxian521-2020](./LICENSE)
2021-10-21 09:51:01 +08:00
## Backers
2021-10-22 17:49:48 +08:00
Thank you very much for your support, I believe the project will get better and better! ! ! :heart:
2021-10-26 12:35:06 +08:00
| xueyuheng | taolei1990 | hang-kim | madwolfcrazy | limuen |
| :--------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: |
| <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> |
2021-10-21 09:51:01 +08:00
## Contributors
2021-10-22 17:52:38 +08:00
This project exists thanks to all the people who contribute!!! :heart:
2021-10-23 19:15:54 +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>