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

168 lines
12 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
2022-11-08 00:48:16 +08:00
`vue-pure-admin` is an open source free and out-of-the-box middle and background management system template. Developed using the latest mainstream technologies such as `Vue3`, `Vite`, `Element-Plus`, `TypeScript`, `Pinia`, `Tailwindcss`
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
2022-11-08 00:48:16 +08:00
## Docs (support `PWA` fast, offline access)
2021-11-28 23:43:52 +08:00
2022-11-08 00:48:16 +08:00
- [Click me to view the domestic documentation site](https://yiming_chang.gitee.io/pure-admin-doc)
- [Click me to view foreign document site](https://xiaoxian521.github.io/pure-admin-doc)
2021-11-28 23:43:52 +08:00
2022-10-28 15:57:11 +08:00
## Thin version (offering non-internationalized and internationalized versions)
2021-11-14 09:15:20 +08:00
2022-10-28 15:57:11 +08:00
- [Click me to view the non-internationalized version](https://github.com/xiaoxian521/pure-admin-thin)
- [Click me to view Internationalization version](https://github.com/xiaoxian521/pure-admin-thin/tree/i18n)
2021-11-14 09:15:20 +08:00
2022-04-19 15:31:08 +08:00
## Tauri
- [Click Watch Tauri](https://github.com/xiaoxian521/tauri-pure-admin)
2022-11-14 12:09:10 +08:00
## Electron
- [Click Watch Electron](https://github.com/xiaoxian521/electron-pure-admin)
## Preview
2021-04-13 18:37:47 +08:00
2022-11-08 00:48:16 +08:00
- [Click me to view the domestic preview station](https://yiming_chang.gitee.io/vue-pure-admin)
- [Click me to view foreign preview site](https://xiaoxian521.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>
- DarkMode
<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>
- Mobile
<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>
### 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
2022-02-18 16:12:40 +08:00
git clone https://gitee.com/yiming_chang/vue-pure-admin.git
2021-04-13 18:37:47 +08:00
```
- 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
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
## Donate
2021-04-13 18:37:47 +08:00
2022-03-07 20:43:27 +08:00
If you think this project is helpful to you, you can help the author buy a glass of juice 🍹 Show your support
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-12-28 13:21:16 +08:00
2021-04-13 18:37:47 +08:00
## License
In principle, no fees and copyrights are charged, and you can use it with confidence, but if you need secondary open source, please contact the author for permission!
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
## Backers
Thank you very much for your support, I believe the project will get better and better :heart:
2021-10-22 17:49:48 +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
## Contributors
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>