You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

90 lines
3.1 KiB

4 years ago
  1. # vue-admin-template
  2. English | [简体中文](./README-zh.md)
  3. > A minimal vue admin template with Element UI & axios & iconfont & permission control & lint
  4. **Live demo:** http://panjiachen.github.io/vue-admin-template
  5. **The current version is `v4.0+` build on `vue-cli`. If you want to use the old version , you can switch branch to [tag/3.11.0](https://github.com/PanJiaChen/vue-admin-template/tree/tag/3.11.0), it does not rely on `vue-cli`**
  6. ## Build Setup
  7. ```bash
  8. # clone the project
  9. git clone https://github.com/PanJiaChen/vue-admin-template.git
  10. # enter the project directory
  11. cd vue-admin-template
  12. # install dependency
  13. npm install
  14. # develop
  15. npm run dev
  16. ```
  17. This will automatically open http://localhost:9528
  18. ## Build
  19. ```bash
  20. # build for test environment
  21. npm run build:stage
  22. # build for production environment
  23. npm run build:prod
  24. ```
  25. ## Advanced
  26. ```bash
  27. # preview the release environment effect
  28. npm run preview
  29. # preview the release environment effect + static resource analysis
  30. npm run preview -- --report
  31. # code format check
  32. npm run lint
  33. # code format check and auto fix
  34. npm run lint -- --fix
  35. ```
  36. Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/guide/essentials/deploy.html) for more information
  37. ## Demo
  38. ![demo](https://github.com/PanJiaChen/PanJiaChen.github.io/blob/master/images/demo.gif)
  39. ## Extra
  40. If you want router permission && generate menu by user roles , you can use this branch [permission-control](https://github.com/PanJiaChen/vue-admin-template/tree/permission-control)
  41. For `typescript` version, you can use [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (Credits: [@Armour](https://github.com/Armour))
  42. ## Related Project
  43. - [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin)
  44. - [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
  45. - [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template)
  46. - [awesome-project](https://github.com/PanJiaChen/vue-element-admin/issues/2312)
  47. ## Browsers support
  48. Modern browsers and Internet Explorer 10+.
  49. | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / 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 |
  50. | --------- | --------- | --------- | --------- |
  51. | IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions
  52. ## License
  53. [MIT](https://github.com/PanJiaChen/vue-admin-template/blob/master/LICENSE) license.
  54. Copyright (c) 2017-present PanJiaChen