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