2024-05-19 13:20:42 +00:00
< div align = "center" > < a href = "https://github.com/anncwb/vue-vben-admin" > < img alt = "VbenAdmin Logo" width = "200" height = "200" src = "https://cdn.jsdelivr.net/gh/vbenjs/vben-cdn-static@0.1.0/vben-admin/logo.png" > < / a > < br > < br >
[![license ](https://img.shields.io/github/license/anncwb/vue-vben-admin.svg )](LICENSE)
2024-07-28 06:29:05 +00:00
< h1 > Vue Vben Admin< / h1 >
2024-05-19 13:20:42 +00:00
< / div >
**English** | [中文 ](./README.zh-CN.md )
## Introduction
Vue Vben Admin is a free and open source middle and back-end template. Using the latest `vue3` , `vite2` , `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.
## Feature
- **State of The Art Development**: Use front-end front-end technology development such as Vue3/vite2
- **TypeScript**: Application-level JavaScript language
- **Theming**: Configurable themes
- **International**: Built-in complete internationalization program
- **Mock Server** Built-in mock data scheme
- **Authority** Built-in complete dynamic routing permission generation scheme.
- **Component** Multiple commonly used components are encapsulated twice
## Preview
- [vue-vben-admin ](https://vben.vvbin.cn/ ) - Full version Chinese site
- [vue-vben-admin-gh-pages ](https://anncwb.github.io/vue-vben-admin/ ) - Full version of the github site
- [vben-admin-thin-next ](https://vben.vvbin.cn/thin/next/ ) - Simplified Chinese site
- [vben-admin-thin-gh-pages ](https://anncwb.github.io/vben-admin-thin-next/ ) -Simplified github site
Test account: vben/123456
< p align = "center" >
< img alt = "VbenAdmin Logo" width = "100%" src = "https://anncwb.github.io/anncwb/images/preview1.png" >
< img alt = "VbenAdmin Logo" width = "100%" src = "https://anncwb.github.io/anncwb/images/preview2.png" >
< img alt = "VbenAdmin Logo" width = "100%" src = "https://anncwb.github.io/anncwb/images/preview3.png" >
< / p >
### Use Gitpod
Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately.
[![Open in Gitpod ](https://gitpod.io/button/open-in-gitpod.svg )](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin)
## Documentation
[Document ](https://doc.vvbin.cn/ )
## Preparation
- [node ](http://nodejs.org/ ) and [git ](https://git-scm.com/ ) - Project development environment
- [Vite ](https://vitejs.dev/ ) - Familiar with vite features
- [Vue3 ](https://v3.vuejs.org/ ) - Familiar with Vue basic syntax
- [TypeScript ](https://www.typescriptlang.org/ ) - Familiar with the basic syntax of `TypeScript`
- [Es6+ ](http://es6.ruanyifeng.com/ ) - Familiar with es6 basic syntax
- [Vue-Router-Next ](https://next.router.vuejs.org/ ) - Familiar with the basic use of vue-router
- [Ant-Design-Vue ](https://2x.antdv.com/docs/vue/introduce-cn/ ) - ui basic use
- [Mock.js ](https://github.com/nuysoft/Mock ) - mockjs basic syntax
## Install and use
- Get the project code
```bash
git clone https://github.com/anncwb/vue-vben-admin.git
```
- Installation dependencies
```bash
cd vue-vben-admin
pnpm install
```
- run
```bash
pnpm serve
```
- build
```bash
pnpm build
```
## Change Log
[CHANGELOG ](./CHANGELOG.zh_CN.md )
## Project
- [vue-vben-admin ](https://github.com/anncwb/vue-vben-admin ) - full version
- [vue-vben-admin-thin-next ](https://github.com/anncwb/vben-admin-thin-next ) - Simplified version
## How to contribute
You are very welcome to join! [Raise an issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) Or submit a Pull Request。
**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`
## Git Contribution submission specification
- 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))
- `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
## Related warehouse
If these plugins are helpful to you, you can give a star support
- [vite-plugin-mock ](https://github.com/anncwb/vite-plugin-mock ) - Used for local and development environment data mock
- [vite-plugin-html ](https://github.com/anncwb/vite-plugin-html ) - Used for html template conversion and compression
- [vite-plugin-compression ](https://github.com/anncwb/vite-plugin-compression ) - Used to pack input .gz|.brotil files
## Browser support
The `Chrome 80+` browser is recommended for local development
Support modern browsers, not 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 > 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 |
## Maintainer
[@Vben ](https://github.com/anncwb )
## Donate
If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support!
![donate ](https://anncwb.github.io/anncwb/images/sponsor.png )
< a style = "display: block;width: 100px;height: 50px;line-height: 50px; color: #fff ;text-align: center; background: #408aed ;border-radius: 4px;" href = "https://www.paypal.com/paypalme/cvvben" > Paypal Me</ a >
2024-06-16 15:50:17 +00:00
## Contributor
< a href = "https://github.com/vbenjs/vue-vben-admin/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=vbenjs/vue-vben-admin" / >
< / a >
2024-05-19 13:20:42 +00:00
## Discord
- [github discussions ](https://github.com/anncwb/vue-vben-admin/discussions )
- [Discord ](https://discord.gg/8GuAdwDhj6 )
## License
[MIT © Vben-2020 ](./LICENSE )