VbenAdmin Logo

[![license](https://img.shields.io/github/license/anncwb/vue-vben-admin.svg)](LICENSE)

Vue Vben Admin

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=vbenjs_vue-vben-admin&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=vbenjs_vue-vben-admin) ![codeql](https://github.com/vbenjs/vue-vben-admin/actions/workflows/codeql.yml/badge.svg) ![build](https://github.com/vbenjs/vue-vben-admin/actions/workflows/build.yml/badge.svg) ![ci](https://github.com/vbenjs/vue-vben-admin/actions/workflows/ci.yml/badge.svg) ![deploy](https://github.com/vbenjs/vue-vben-admin/actions/workflows/deploy.yml/badge.svg) **English** | [中文](./README.zh-CN.md) | [日本語](./README.ja-JP.md) ## Introduction Vue Vben Admin is a free and open source middle and back-end template. Using the latest `vue3`, `vite`, `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. ## Upgrade Notice This is the latest version, 5.0, and it is not compatible with previous versions. If you are starting a new project, it is recommended to use the latest version. If you wish to view the old version, please use the [v2 branch](https://github.com/vbenjs/vue-vben-admin/tree/v2). ## Feature - **Latest Technology Stack**: Developed with cutting-edge front-end technologies like Vue 3 and Vite - **TypeScript**: A language for application-scale JavaScript - **Themes**: Multiple theme colors available with customizable options - **Internationalization**: Comprehensive built-in internationalization support - **Permissions**: Built-in solution for dynamic route-based permission generation ## Preview - [Vben Admin](https://vben.pro/) - Full version Chinese site Test Account: vben/123456

VbenAdmin Logo VbenAdmin Logo VbenAdmin Logo

### 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/vbenjs/vue-vben-admin) ## Documentation [Document](https://doc.vben.pro/) ## Install and use - Get the project code ```bash git clone https://github.com/vbenjs/vue-vben-admin.git ``` - Installation dependencies ```bash cd vue-vben-admin corepack enable pnpm install ``` - run ```bash pnpm dev ``` - build ```bash pnpm build ``` ## Change Log [CHANGELOG](https://github.com/vbenjs/vue-vben-admin/releases) ## 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. - `ci` Continuous integration - `types` Type definition file changes - `wip` In development ## Browser support The `Chrome 80+` browser is recommended for local development Support modern browsers, not IE | [ Edge](http://godban.github.io/browsers-support-badges/)
IE | [ Edge](http://godban.github.io/browsers-support-badges/)
Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
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://unpkg.com/@vbenjs/static-source@0.1.6/source/sponsor.png) Paypal Me ## Contributor Contributors ## Discord - [Github Discussions](https://github.com/anncwb/vue-vben-admin/discussions) ## License [MIT © Vben-2020](./LICENSE)