### 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://vvbin.cn/doc-next/) ## 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 yarn install ``` - run ```bash yarn serve ``` - build ```bash yarn 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-style-import](https://github.com/anncwb/vite-plugin-style-import) - Used for component library style introduction on demand - [vite-plugin-theme](https://github.com/anncwb/vite-plugin-theme) - Used for online switching of theme colors and other color-related configurations - [vite-plugin-imagemin](https://github.com/anncwb/vite-plugin-imagemin) - Used to pack compressed image resources - [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, not 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) ## 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) Paypal Me ## Discord - [github discussions](https://github.com/anncwb/vue-vben-admin/discussions) - [Discord](https://discord.gg/8GuAdwDhj6) ## License [MIT © Vben-2020](./LICENSE)