| 提交 | 用户 | age | ||
| ee5fb2 | 1 | <div align="center"> <a href="https://github.com/anncwb/vue-vben-admin"> <img alt="VbenAdmin Logo" width="200" height="200" src="https://anncwb.github.io/anncwb/images/logo.png"> </a> <br> <br> |
| 351f60 | 2 | |
| ee5fb2 | 3 | [](LICENSE) |
| 351f60 | 4 | |
| ee5fb2 | 5 | <h1>Vue vben admin</h1> |
| V | 6 | </div> |
| 351f60 | 7 | |
| ee5fb2 | 8 | **English** | [中文](./README.zh-CN.md) |
| 351f60 | 9 | |
| 025ee9 | 10 | ## Introduction |
| 351f60 | 11 | |
| 1262e1 | 12 | Vue Vben Admin is a free and open source middle and back-end template. Using the latest `vue3`, `vite4`, `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. |
| afbcf0 | 13 | |
| ee5fb2 | 14 | ## Feature |
| afbcf0 | 15 | |
| ee5fb2 | 16 | - **State of The Art Development**：Use front-end front-end technology development such as Vue3/vite2 |
| V | 17 | - **TypeScript**: Application-level JavaScript language |
| 18 | - **Theming**: Configurable themes | |
| 19 | - **International**：Built-in complete internationalization program | |
| 20 | - **Mock Server** Built-in mock data scheme | |
| 21 | - **Authority** Built-in complete dynamic routing permission generation scheme. | |
| 22 | - **Component** Multiple commonly used components are encapsulated twice | |
| afbcf0 | 23 | |
| e09760 | 24 | ## Preview |
| 8f4d51 | 25 | |
| 2387dc | 26 | - [vue-vben-admin](https://vben.vvbin.cn/) - Full version Chinese site |
| ee5fb2 | 27 | - [vue-vben-admin-gh-pages](https://anncwb.github.io/vue-vben-admin/) - Full version of the github site |
| 2387dc | 28 | - [vben-admin-thin-next](https://vben.vvbin.cn/thin/next/) - Simplified Chinese site |
| ee5fb2 | 29 | - [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) -Simplified github site |
| 8f4d51 | 30 | |
| ee5fb2 | 31 | Test account: vben/123456 |
| 03b602 | 32 | |
| afbcf0 | 33 | <p align="center"> |
| ee5fb2 | 34 | <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview1.png"> |
| V | 35 | <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview2.png"> |
| 36 | <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview3.png"> | |
| afbcf0 | 37 | </p> |
| ee5fb2 | 38 | |
| V | 39 | ### Use Gitpod |
| 40 | ||
| 41 | Open the project in Gitpod (free online dev environment for GitHub) and start coding immediately. | |
| 42 | ||
| 43 | [](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin) | |
| afbcf0 | 44 | |
| 025ee9 | 45 | ## Documentation |
| afbcf0 | 46 | |
| 7fad00 | 47 | [Document](https://doc.vvbin.cn/) |
| afbcf0 | 48 | |
| ee5fb2 | 49 | ## Preparation |
| afbcf0 | 50 | |
| ee5fb2 | 51 | - [node](http://nodejs.org/) and [git](https://git-scm.com/) - Project development environment |
| V | 52 | - [Vite](https://vitejs.dev/) - Familiar with vite features |
| 53 | - [Vue3](https://v3.vuejs.org/) - Familiar with Vue basic syntax | |
| 54 | - [TypeScript](https://www.typescriptlang.org/) - Familiar with the basic syntax of `TypeScript` | |
| 55 | - [Es6+](http://es6.ruanyifeng.com/) - Familiar with es6 basic syntax | |
| 56 | - [Vue-Router-Next](https://next.router.vuejs.org/) - Familiar with the basic use of vue-router | |
| 1262e1 | 57 | - [Ant-Design-Vue](https://antdv.com/docs/vue/introduce-cn/) - ui basic use |
| ee5fb2 | 58 | - [Mock.js](https://github.com/nuysoft/Mock) - mockjs basic syntax |
| afbcf0 | 59 | |
| ee5fb2 | 60 | ## Install and use |
| afbcf0 | 61 | |
| ee5fb2 | 62 | - Get the project code |
| 351f60 | 63 | |
| 025ee9 | 64 | ```bash |
| ee5fb2 | 65 | git clone https://github.com/anncwb/vue-vben-admin.git |
| V | 66 | ``` |
| 351f60 | 67 | |
| ee5fb2 | 68 | - Installation dependencies |
| 351f60 | 69 | |
| ee5fb2 | 70 | ```bash |
| V | 71 | cd vue-vben-admin |
| 351f60 | 72 | |
| 999965 | 73 | pnpm install |
| 351f60 | 74 | |
| 陈 | 75 | ``` |
| 76 | ||
| ee5fb2 | 77 | - run |
| 351f60 | 78 | |
| 陈 | 79 | ```bash |
| 999965 | 80 | pnpm serve |
| 351f60 | 81 | ``` |
| 陈 | 82 | |
| ee5fb2 | 83 | - build |
| 351f60 | 84 | |
| 陈 | 85 | ```bash |
| 999965 | 86 | pnpm build |
| 351f60 | 87 | ``` |
| 陈 | 88 | |
| c659c1 | 89 | - docker |
| 胤 | 90 | |
| 91 | ### The dockerFile is located in the project root directory and supports differential deployment | |
| 92 | ||
| 93 | #### build image | |
| 94 | ||
| 95 | ```bash | |
| 96 | docker build -t vue-vben-admin . | |
| 97 | ``` | |
| 98 | ||
| 99 | #### Environment variables are dynamically used to achieve differentiated container deployment. Different VG_BASE_URL environment variables point to different back-end service addresses. In the following example, http://localhost:3333 is used as the back-end service address and the container is mapped to port 6666 | |
| 100 | ||
| 101 | ```bash | |
| 102 | docker run --name vue-vben-admin -d -p 6666:80 -e VG_BASE_URL=http://localhost:3333 vue-vben-admin | |
| 103 | ``` | |
| 104 | ||
| 105 | Then you can navigate http://localhost:6666 | |
| 106 | ||
| ee5fb2 | 107 | ## Change Log |
| 351f60 | 108 | |
| ee5fb2 | 109 | [CHANGELOG](./CHANGELOG.zh_CN.md) |
| 351f60 | 110 | |
| ee5fb2 | 111 | ## Project |
| 351f60 | 112 | |
| ee5fb2 | 113 | - [vue-vben-admin](https://github.com/anncwb/vue-vben-admin) - full version |
| V | 114 | - [vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next) - Simplified version |
| 351f60 | 115 | |
| ee5fb2 | 116 | ## How to contribute |
| 351f60 | 117 | |
| ee5fb2 | 118 | You are very welcome to join！[Raise an issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) Or submit a Pull Request。 |
| 351f60 | 119 | |
| ee5fb2 | 120 | **Pull Request:** |
| 351f60 | 121 | |
| 025ee9 | 122 | 1. Fork code! |
| V | 123 | 2. Create your own branch: `git checkout -b feat/xxxx` |
| 124 | 3. Submit your changes: `git commit -am 'feat(function): add xxxxx'` | |
| 125 | 4. Push your branch: `git push origin feat/xxxx` | |
| 126 | 5. submit`pull request` | |
| 351f60 | 127 | |
| ee5fb2 | 128 | ## Git Contribution submission specification |
| 351f60 | 129 | |
| ee5fb2 | 130 | - 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)) |
| afbcf0 | 131 | |
| ee5fb2 | 132 | - `feat` Add new features |
| V | 133 | - `fix` Fix the problem/BUG |
| 134 | - `style` The code style is related and does not affect the running result | |
| 135 | - `perf` Optimization/performance improvement | |
| 136 | - `refactor` Refactor | |
| 137 | - `revert` Undo edit | |
| 138 | - `test` Test related | |
| 139 | - `docs` Documentation/notes | |
| 140 | - `chore` Dependency update/scaffolding configuration modification etc. | |
| 141 | - `workflow` Workflow improvements | |
| 142 | - `ci` Continuous integration | |
| 143 | - `types` Type definition file changes | |
| 144 | - `wip` In development | |
| afbcf0 | 145 | |
| ee5fb2 | 146 | ## Related warehouse |
| faf3f4 | 147 | |
| ee5fb2 | 148 | If these plugins are helpful to you, you can give a star support |
| V | 149 | |
| 150 | - [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - Used for local and development environment data mock | |
| 151 | - [vite-plugin-html](https://github.com/anncwb/vite-plugin-html) - Used for html template conversion and compression | |
| 152 | - [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression) - Used to pack input .gz|.brotil files | |
| 2c6aa8 | 153 | - [vite-plugin-svg-icons](https://github.com/anncwb/vite-plugin-svg-icons) - Used to quickly generate svg sprite |
| 351f60 | 154 | |
| 025ee9 | 155 | ## Browser support |
| 70fba7 | 156 | |
| ee5fb2 | 157 | The `Chrome 80+` browser is recommended for local development |
| 70fba7 | 158 | |
| ee5fb2 | 159 | Support modern browsers, not IE |
| 70fba7 | 160 | |
| 8a1bfd | 161 | | [<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 | |
| V | 162 | | :-: | :-: | :-: | :-: | :-: | |
| 163 | | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | | |
| 164 | ||
| ee5fb2 | 165 | ## Maintainer |
| 70fba7 | 166 | |
| 3689bd | 167 | [@Vben](https://github.com/anncwb) [@Jinmao](https://github.com/jinmao88) |
| 173d40 | 168 | |
| 52aba6 | 169 | ## Thanks |
| 173d40 | 170 | |
| 52aba6 | 171 | <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="120"> |
| ee5fb2 | 172 | |
| 3689bd | 173 | ## Star History Chart |
| IW | 174 | |
| 175 | [](https://star-history.com/#vbenjs/vue-vben-admin&Date) | |
| ee5fb2 | 176 | |
| V | 177 | ## License |
| 178 | ||
| 179 | [MIT © Vben-2020](./LICENSE) | |
