| 提交 | 用户 | age | ||
| 351f60 | 1 | <p align="center"> |
| 陈 | 2 | <a href="https://github.com/anncwb/vue-vben-admin" target="_blank"> |
| 025ee9 | 3 | <img alt="VbenAdmin Logo" width="200" src="/anncwb/vue-vben-admin/raw/main/.github/res/imgs/logo.png"> |
| 351f60 | 4 | </a> |
| 陈 | 5 | </p> |
| afbcf0 | 6 | <h2 align="center">VUE VBEN ADMIN2.0</h2> |
| 351f60 | 7 | |
| 025ee9 | 8 | [Chinese](./README.zh-CN.md) | **English** |
| 351f60 | 9 | |
| 025ee9 | 10 | [CHANGELOG](CHANGELOG.en_US.md) |
| 351f60 | 11 | |
| 025ee9 | 12 | - [Introduction](#introduction) |
| V | 13 | - [GitHub](#github) |
| 14 | - [Thin](#thin) | |
| 15 | - [Preview](#preview) | |
| 16 | - [Documentation](#documentation) | |
| 17 | - [Preinstallation](#preinstallation) | |
| 18 | - [Environmental requirements](#environmental-requirements) | |
| 19 | - [UI framework](#ui-framework) | |
| 20 | - [Icon](#icon) | |
| 21 | - [Plugin](#plugin) | |
| 22 | - [Suggested development environment](#suggested-development-environment) | |
| 23 | - [Install](#install) | |
| 24 | - [Usage](#usage) | |
| 25 | - [Development environment](#development-environment) | |
| 26 | - [Build](#build) | |
| 27 | - [Format](#format) | |
| 28 | - [Other](#other) | |
| 29 | - [Git submit specifications](#git-submit-specifications) | |
| 30 | - [Code contribution](#code-contribution) | |
| 31 | - [Finished features](#finished-features) | |
| 32 | - [Developing features](#developing-features) | |
| 33 | - [Browser support](#browser-support) | |
| 34 | - [Plugins](#plugins) | |
| 351f60 | 35 | |
| 025ee9 | 36 | ## Introduction |
| 351f60 | 37 | |
| 025ee9 | 38 | The project is based on the vue3 style background management system implemented by ʻant-design-vue`, `typescript`,`vue3.0`,`vite`,`tsx`, |
| afbcf0 | 39 | |
| 025ee9 | 40 | ## GitHub |
| afbcf0 | 41 | |
| 025ee9 | 42 | [vue-vben-admin2.0](https://github.com/anncwb/vue-vben-admin) - `main` branch |
| afbcf0 | 43 | |
| 025ee9 | 44 | ### Thin |
| 8f4d51 | 45 | |
| V | 46 | [vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next) |
| 47 | ||
| 025ee9 | 48 | ## Preview |
| afbcf0 | 49 | |
| 025ee9 | 50 | - [2.0 preview](https://vvbin.cn/next/) |
| 8f4d51 | 51 | |
| 025ee9 | 52 | - [2.0 Thin Preview](https://vvbin.cn/thin/next/) |
| afbcf0 | 53 | |
| 025ee9 | 54 | Account for test: vben/123456 |
| 03b602 | 55 | |
| afbcf0 | 56 | <p align="center"> |
| V | 57 | <img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview1.png"> |
| 58 | <img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview2.png"> | |
| 59 | <img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview3.png"> | |
| 60 | </p> | |
| 61 | ||
| 025ee9 | 62 | ## Documentation |
| afbcf0 | 63 | |
| 025ee9 | 64 | The documentation for 2.0 hasn't started yet, it will be provided later. |
| afbcf0 | 65 | |
| 025ee9 | 66 | ## Preinstallation |
| afbcf0 | 67 | |
| 025ee9 | 68 | ### Environmental requirements |
| afbcf0 | 69 | |
| 025ee9 | 70 | - `Node.js`: - Version>`12.0.0` is better. |
| V | 71 | - `yarn` > `npm` > `cnpm`: - Package management tool. |
| afbcf0 | 72 | |
| 025ee9 | 73 | ### UI framework |
| afbcf0 | 74 | |
| 025ee9 | 75 | - [Tailwind CSS](https://tailwindcss.com/) - 2.0.0-beta.5 has deleted. |
| afbcf0 | 76 | - [Ant Design Vue 2.0](https://2x.antdv.com/docs/vue/introduce-cn/) |
| V | 77 | |
| 025ee9 | 78 | ### Icon |
| afbcf0 | 79 | |
| 025ee9 | 80 | - [Ant Design Vue Icon Component](https://2x.antdv.com/components/icon-cn/) - Icon which is imported on demand. |
| V | 81 | - [Iconify](https://iconify.design) - Icon can be used [Icônes](https://icones.netlify.app/) |
| 82 | - [PurgeIcons](https://github.com/antfu/purge-icons) - Icon which is used by build. | |
| afbcf0 | 83 | |
| 025ee9 | 84 | ### Plugin |
| afbcf0 | 85 | |
| V | 86 | - [Vue Router Next](https://github.com/vuejs/vue-router-next) |
| 87 | - [Vuex Next](https://github.com/vuejs/vuex) | |
| 025ee9 | 88 | - [vuex-module-decorators](https://github.com/championswimmer/vuex-module-decorators) - vuex modular |
| V | 89 | - [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - Mock plugin base on vite |
| 90 | - [vue-i18n](https://github.com/intlify/vue-i18n-next) - Internationalization | |
| 91 | - [lodash-es](https://github.com/lodash/lodash) - JavaScript utility library | |
| 92 | - [axios](https://github.com/axios/axios) - Http data interaction | |
| afbcf0 | 93 | - [TypeScript](https://www.typescriptlang.org/) |
| 351f60 | 94 | |
| 025ee9 | 95 | ### Suggested development environment |
| 351f60 | 96 | |
| 025ee9 | 97 | - `Git`: - Tool of version management |
| V | 98 | - `Visual Studio Code` - (VSCode): Latest version |
| afbcf0 | 99 | - [VS Code Extensions](./.vscode/extensions.json) |
| V | 100 | - [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) |
| 025ee9 | 101 | - [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) - Tailwind css style association |
| V | 102 | - [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur) - Essential for vue development |
| 103 | - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - Checking script code | |
| 104 | - [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - Code formatting | |
| 105 | - [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - Css formatting | |
| 351f60 | 106 | |
| 025ee9 | 107 | ## Install |
| 351f60 | 108 | |
| 025ee9 | 109 | ```bash |
| V | 110 | # Make git case sensitive to file names |
| afbcf0 | 111 | git config core.ignorecase false |
| 351f60 | 112 | |
| 025ee9 | 113 | # Pull code of the project |
| afbcf0 | 114 | git clone https://github.com/anncwb/vue-vben-admin.git vue-vben-admin-2.0 |
| 351f60 | 115 | |
| afbcf0 | 116 | cd vue-vben-admin-2.0 |
| 351f60 | 117 | |
| 025ee9 | 118 | # If you use other package management tool, you can install it by yourself |
| V | 119 | # if you hasn't install yarn, please run: npm install -g yarn |
| 351f60 | 120 | yarn install |
| 陈 | 121 | |
| 122 | ``` | |
| 123 | ||
| 025ee9 | 124 | ## Usage |
| 351f60 | 125 | |
| 025ee9 | 126 | ### Development environment |
| 351f60 | 127 | |
| 陈 | 128 | ```bash |
| 129 | yarn serve | |
| 130 | ``` | |
| 131 | ||
| 025ee9 | 132 | ### Build |
| 351f60 | 133 | |
| 陈 | 134 | ```bash |
| 135 | ||
| 025ee9 | 136 | yarn build # build |
| 351f60 | 137 | |
| 025ee9 | 138 | yarn build:no-cache # build, cache will be removed before build |
| 351f60 | 139 | |
| 025ee9 | 140 | yarn report # Generate build package report preview |
| 351f60 | 141 | ``` |
| 陈 | 142 | |
| 025ee9 | 143 | ### Format |
| 351f60 | 144 | |
| 陈 | 145 | ```bash |
| 025ee9 | 146 | yarn lint:stylelint # css formatting |
| 351f60 | 147 | |
| 025ee9 | 148 | yarn lint:prettier # js/ts code formatting |
| 351f60 | 149 | ``` |
| 陈 | 150 | |
| 025ee9 | 151 | ### Other |
| 351f60 | 152 | |
| 陈 | 153 | ```bash |
| 025ee9 | 154 | yarn reinstall # Remove dependencies and reinstall, supported window |
| 351f60 | 155 | |
| 025ee9 | 156 | yarn preview # Build and preview in local |
| 351f60 | 157 | |
| 025ee9 | 158 | yarn log # Generate CHANGELOG |
| afbcf0 | 159 | |
| 025ee9 | 160 | yarn clean:cache # Delete cache |
| afbcf0 | 161 | |
| 025ee9 | 162 | yarn clean:lib # Delete node_modules, supported window |
| 351f60 | 163 | ``` |
| 陈 | 164 | |
| 025ee9 | 165 | ## Git submit specifications |
| 351f60 | 166 | |
| 025ee9 | 167 | - Refer to [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specifications ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) |
| 351f60 | 168 | |
| 025ee9 | 169 | - `feat` Add new features |
| V | 170 | - `fix` Fix problem/BUG |
| 171 | - `style` Code style related and doesn't affect the running result | |
| 172 | - `perf` Optimization/performance improvement | |
| 173 | - `refactor` Refactor | |
| 174 | - `revert` Undo edit | |
| 175 | - `test` Test related | |
| 176 | - `docs` Documentation/notes | |
| 177 | - `chore` Dependent update/scaffolding configuration modification etc | |
| 178 | - `workflow` Workflow improvements | |
| 179 | - `ci` Continuous integration | |
| 180 | - `types` Update file of type definition | |
| 181 | - `wip` Developing | |
| 351f60 | 182 | |
| 025ee9 | 183 | ## Code contribution |
| 351f60 | 184 | |
| 025ee9 | 185 | 1. Fork code! |
| V | 186 | 2. Create your own branch: `git checkout -b feat/xxxx` |
| 187 | 3. Submit your changes: `git commit -am 'feat(function): add xxxxx'` | |
| 188 | 4. Push your branch: `git push origin feat/xxxx` | |
| 189 | 5. submit`pull request` | |
| 351f60 | 190 | |
| 025ee9 | 191 | ## Finished features |
| 351f60 | 192 | |
| 025ee9 | 193 | - [x] Project construction (based on vite）) |
| V | 194 | - [x] Login and exit |
| 195 | - [x] Menu (can search, drag and drop and menu layout) | |
| 196 | - [x] Multiple tabs/breadcrumbs | |
| 197 | - [x] Permission management base on role | |
| 198 | - [x] Permission management base on background | |
| 199 | - [x] The separation of routing and menu settings | |
| 200 | - [x] Collapsible sidebar | |
| 201 | - [x] Draggable sidebar | |
| 202 | - [x] Multi-tab mode/global control | |
| 203 | - [x] Menu search | |
| 204 | - [x] Page loading | |
| 205 | - [x] Scroll bar component | |
| 206 | - [x] Pop-up window expansion (dragable, full screen, adaptive height) | |
| 207 | - [x] Mock data | |
| 208 | - [x] hook Package | |
| 209 | - [x] Form component | |
| 210 | - [x] Right-click menu | |
| 211 | - [x] Watermark plugin | |
| 212 | - [x] Animation component | |
| 213 | - [x] QR code plugin | |
| 214 | - [x] Internationalization plugin | |
| 215 | - [x] Details component | |
| 216 | - [x] Validation component | |
| 217 | - [x] Tree component | |
| 218 | - [x] Picture preview component | |
| 219 | - [x] Table component | |
| 220 | - [x] Chart library | |
| 221 | - [x] Digital animation | |
| 222 | - [x] First screen loading waiting animation | |
| 223 | - [x] Extract the production environment profile | |
| 224 | - [x] Build Gzip | |
| 225 | - [x] System performance optimization | |
| 226 | - [x] Data import and export | |
| 227 | - [x] Global error handling | |
| 228 | - [x] Rich text component | |
| 229 | - [x] Upload component | |
| afbcf0 | 230 | |
| 025ee9 | 231 | ## Developing features |
| afbcf0 | 232 | |
| 025ee9 | 233 | - [ ] Theme configuration |
| V | 234 | - [ ] Dark theme |
| 235 | - [ ] Build CDN | |
| faf3f4 | 236 | |
| 025ee9 | 237 | If you have more components/functions/suggestions/bugs/, welcome to submit pr or issue. |
| 351f60 | 238 | |
| 025ee9 | 239 | ## Browser support |
| 70fba7 | 240 | |
| 025ee9 | 241 | It is recommended to use the `Chrome` browser for local development. Development in the Firefox browser is relatively slow. |
| 70fba7 | 242 | |
| 025ee9 | 243 | Support modern browsers, Not currently supported ie11，Follow-up consideration support ie11 |
| 70fba7 | 244 | |
| 8a1bfd | 245 | | [<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 | 246 | | :-: | :-: | :-: | :-: | :-: | |
| 247 | | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | | |
| 248 | ||
| 025ee9 | 249 | More browsers can view [Can I Use Es Module](https://caniuse.com/?search=ES%20Module) |
| 70fba7 | 250 | |
| 025ee9 | 251 | ## Plugins |
| 173d40 | 252 | |
| 025ee9 | 253 | If these plugins are helpful to you, you can give a star |
| 173d40 | 254 | |
| 025ee9 | 255 | - [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) |
| V | 256 | - [vite-plugin-html](https://github.com/anncwb/vite-plugin-html) |
| 257 | - [vite-plugin-style-import](https://github.com/vbenjs/vite-plugin-style-import) | |
