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

Vue vben admin

**English** | [中文](./README.zh-CN.md) ## Introduction Vue Vben Admin is a free and open source middle platform/back-end template. Using the latest `vue3`, `vite4`, `TypeScript` and other mainstream technology, Vben is the out-of-the-box front-end solution for both production and learning purpose. ## Features - **State-of-art Techinical Stack**：Using the latest and popular front-end technology such as Vue3/vite2 - **TypeScript**: Application-level JavaScript language - **Theming**: Configurable themes - **International**：Built-in i18n support - **Response Mock**: Built-in response mock ability - **Authority**: Built-in permission system based on dynamic routes. - **Component**: Extracted and encapsulated components for various scenarios. ## Preview - [vue-vben-admin](https://vben.vvbin.cn/) - Full version (Chinese) - [vue-vben-admin-gh-pages](https://anncwb.github.io/vue-vben-admin/) - Full version (github hosted) - [vben-admin-thin-next](https://vben.vvbin.cn/thin/next/) - Simplified Version (Chinese) - [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) -Simplified Version (github hosted) Test account: vben/123456

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/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://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/vbenjs/vue-vben-admin.git ``` - Install dependencies ```bash cd vue-vben-admin pnpm install ``` - run ```bash pnpm serve ``` - build ```bash pnpm build ``` - docker ### The dockerFile is located in the project root directory and supports differential deployment #### build image ```bash docker build -t vue-vben-admin . ``` #### Use environment variables to achieve differentiated container deployment. Specify service endpoint by assigning `VG_BASE_URL`. In the following example, `http://localhost:3333` is used as the back-end service address and the container is mapped to port `6666`: ```bash docker run --name vue-vben-admin -d -p 6666:80 -e VG_BASE_URL=http://localhost:3333 vue-vben-admin ``` Then you can navigate to `http://localhost:6666` ## 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` Modify the code style/format that does not affect the feature - `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 show support by leaving a star! - [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 - [vite-plugin-svg-icons](https://github.com/anncwb/vite-plugin-svg-icons) - Used to quickly generate svg sprite ## Browser support The `Chrome 80+` browser is recommended for local development Support modern browsers, doesn't include IE | [

](http://godban.github.io/browsers-support-badges/)
IE | [

](http://godban.github.io/browsers-support-badges/)
Edge | [

](http://godban.github.io/browsers-support-badges/)
Firefox | [

](http://godban.github.io/browsers-support-badges/)
Chrome | [

](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) [@Jinmao](https://github.com/jinmao88) ## Thanks

## Star History Chart [![Star History Chart](https://api.star-history.com/svg?repos=vbenjs/vue-vben-admin&type=Date)](https://star-history.com/#vbenjs/vue-vben-admin&Date) ## License [MIT © Vben-2020](./LICENSE)