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.

236 lines
8.7 KiB

3 years ago
  1. <p align="center">
  2. <img width="320" src="https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg">
  3. </p>
  4. <p align="center">
  5. <a href="https://github.com/vuejs/vue">
  6. <img src="https://img.shields.io/badge/vue-2.6.10-brightgreen.svg" alt="vue">
  7. </a>
  8. <a href="https://github.com/ElemeFE/element">
  9. <img src="https://img.shields.io/badge/element--ui-2.7.0-brightgreen.svg" alt="element-ui">
  10. </a>
  11. <a href="https://travis-ci.org/PanJiaChen/vue-element-admin" rel="nofollow">
  12. <img src="https://travis-ci.org/PanJiaChen/vue-element-admin.svg?branch=master" alt="Build Status">
  13. </a>
  14. <a href="https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE">
  15. <img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="license">
  16. </a>
  17. <a href="https://github.com/PanJiaChen/vue-element-admin/releases">
  18. <img src="https://img.shields.io/github/release/PanJiaChen/vue-element-admin.svg" alt="GitHub release">
  19. </a>
  20. <a href="https://gitter.im/vue-element-admin/discuss">
  21. <img src="https://badges.gitter.im/Join%20Chat.svg" alt="gitter">
  22. </a>
  23. <a href="https://panjiachen.github.io/vue-element-admin-site/donate">
  24. <img src="https://img.shields.io/badge/%24-donate-ff69b4.svg" alt="donate">
  25. </a>
  26. </p>
  27. English | [简体中文](./README.zh-CN.md) | [日本語](./README.ja.md) | [Spanish](./README.es.md)
  28. <p align="center">
  29. <b>SPONSORED BY</b>
  30. </p>
  31. <p align="center">
  32. <a href="https://finclip.com?from=vue_element" title="FinClip" target="_blank">
  33. <img height="200px" src="https://gitee.com/panjiachen/gitee-cdn/raw/master/vue%E8%B5%9E%E5%8A%A9.png" title="FinClip">
  34. </a>
  35. </p>
  36. ## Introduction
  37. [vue-element-admin](https://panjiachen.github.io/vue-element-admin) is a production-ready front-end solution for admin interfaces. It is based on [vue](https://github.com/vuejs/vue) and uses the UI Toolkit [element-ui](https://github.com/ElemeFE/element).
  38. [vue-element-admin](https://panjiachen.github.io/vue-element-admin) is based on the newest development stack of vue and it has a built-in i18n solution, typical templates for enterprise applications, and lots of awesome features. It helps you build large and complex Single-Page Applications. I believe whatever your needs are, this project will help you.
  39. - [Preview](https://panjiachen.github.io/vue-element-admin)
  40. - [Documentation](https://panjiachen.github.io/vue-element-admin-site/)
  41. - [Gitter](https://gitter.im/vue-element-admin/discuss)
  42. - [Donate](https://panjiachen.github.io/vue-element-admin-site/donate/)
  43. - [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
  44. - [Gitee](https://panjiachen.gitee.io/vue-element-admin/) 国内用户可访问该地址在线预览
  45. - Base template recommends using: [vue-admin-template](https://github.com/PanJiaChen/vue-admin-template)
  46. - Typescript: [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (Credits: [@Armour](https://github.com/Armour))
  47. - [awesome-project](https://github.com/PanJiaChen/vue-element-admin/issues/2312)
  48. **After the `v4.1.0+` version, the default master branch will not support i18n. Please use [i18n Branch](https://github.com/PanJiaChen/vue-element-admin/tree/i18n), it will keep up with the master update**
  49. **The current version is `v4.0+` build on `vue-cli`. If you find a problem, please put [issue](https://github.com/PanJiaChen/vue-element-admin/issues/new). If you want to use the old version , you can switch branch to [tag/3.11.0](https://github.com/PanJiaChen/vue-element-admin/tree/tag/3.11.0), it does not rely on `vue-cli`**
  50. **This project does not support low version browsers (e.g. IE). Please add polyfill by yourself.**
  51. ## Preparation
  52. You need to install [node](https://nodejs.org/) and [git](https://git-scm.com/) locally. The project is based on [ES2015+](https://es6.ruanyifeng.com/), [vue](https://cn.vuejs.org/index.html), [vuex](https://vuex.vuejs.org/zh-cn/), [vue-router](https://router.vuejs.org/zh-cn/), [vue-cli](https://github.com/vuejs/vue-cli) , [axios](https://github.com/axios/axios) and [element-ui](https://github.com/ElemeFE/element), all request data is simulated using [Mock.js](https://github.com/nuysoft/Mock).
  53. Understanding and learning this knowledge in advance will greatly help the use of this project.
  54. [![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/PanJiaChen/vue-element-admin/tree/CodeSandbox)
  55. <p align="center">
  56. <img width="900" src="https://wpimg.wallstcn.com/a5894c1b-f6af-456e-82df-1151da0839bf.png">
  57. </p>
  58. ## Sponsors
  59. Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor]](https://www.patreon.com/panjiachen)
  60. ### Akveo
  61. <a href="https://store.akveo.com/products/vue-java-admin-dashboard-spring?utm_campaign=akveo_store-Vue-Vue_demo%2Fgithub&utm_source=vue_admin&utm_medium=referral&utm_content=github_banner"><img width="500px" src="https://raw.githubusercontent.com/PanJiaChen/vue-element-admin-site/master/docs/.vuepress/public/images/vue-java-banner.png" /></a><p>Get Java backend for Vue admin with 20% discount for 39$ use coupon code SWB0RAZPZR1M
  62. </p>
  63. ### Flatlogic
  64. <a href="https://flatlogic.com/admin-dashboards?from=vue-element-admin"><img width="150px" src="https://wpimg.wallstcn.com/9c0b719b-5551-4c1e-b776-63994632d94a.png" /></a><p>Admin Dashboard Templates made with Vue, React and Angular.</p>
  65. ## Features
  66. ```
  67. - Login / Logout
  68. - Permission Authentication
  69. - Page permission
  70. - Directive permission
  71. - Permission configuration page
  72. - Two-step login
  73. - Multi-environment build
  74. - Develop (dev)
  75. - sit
  76. - Stage Test (stage)
  77. - Production (prod)
  78. - Global Features
  79. - I18n
  80. - Multiple dynamic themes
  81. - Dynamic sidebar (supports multi-level routing)
  82. - Dynamic breadcrumb
  83. - Tags-view (Tab page Support right-click operation)
  84. - Svg Sprite
  85. - Mock data
  86. - Screenfull
  87. - Responsive Sidebar
  88. - Editor
  89. - Rich Text Editor
  90. - Markdown Editor
  91. - JSON Editor
  92. - Excel
  93. - Export Excel
  94. - Upload Excel
  95. - Visualization Excel
  96. - Export zip
  97. - Table
  98. - Dynamic Table
  99. - Drag And Drop Table
  100. - Inline Edit Table
  101. - Error Page
  102. - 401
  103. - 404
  104. - Components
  105. - Avatar Upload
  106. - Back To Top
  107. - Drag Dialog
  108. - Drag Select
  109. - Drag Kanban
  110. - Drag List
  111. - SplitPane
  112. - Dropzone
  113. - Sticky
  114. - CountTo
  115. - Advanced Example
  116. - Error Log
  117. - Dashboard
  118. - Guide Page
  119. - ECharts
  120. - Clipboard
  121. - Markdown to html
  122. ```
  123. ## Getting started
  124. ```bash
  125. # clone the project
  126. git clone https://github.com/PanJiaChen/vue-element-admin.git
  127. # enter the project directory
  128. cd vue-element-admin
  129. # install dependency
  130. npm install
  131. # develop
  132. npm run dev
  133. ```
  134. This will automatically open http://localhost:9527
  135. ## Build
  136. ```bash
  137. # build for test environment
  138. npm run build:stage
  139. # build for production environment
  140. npm run build:prod
  141. ```
  142. ## Advanced
  143. ```bash
  144. # preview the release environment effect
  145. npm run preview
  146. # preview the release environment effect + static resource analysis
  147. npm run preview -- --report
  148. # code format check
  149. npm run lint
  150. # code format check and auto fix
  151. npm run lint -- --fix
  152. ```
  153. Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/guide/essentials/deploy.html) for more information
  154. ## Changelog
  155. Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).
  156. ## Online Demo
  157. [Preview](https://panjiachen.github.io/vue-element-admin)
  158. ## Donate
  159. If you find this project useful, you can buy author a glass of juice :tropical_drink:
  160. ![donate](https://wpimg.wallstcn.com/bd273f0d-83a0-4ef2-92e1-9ac8ed3746b9.png)
  161. [Paypal Me](https://www.paypal.me/panfree23)
  162. [Buy me a coffee](https://www.buymeacoffee.com/Pan)
  163. ## Browsers support
  164. Modern browsers and Internet Explorer 10+.
  165. | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](https://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" />](https://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" />](https://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" />](https://godban.github.io/browsers-support-badges/)</br>Safari |
  166. | --------- | --------- | --------- | --------- |
  167. | IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions |
  168. ## License
  169. [MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)
  170. Copyright (c) 2017-present PanJiaChen