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.

259 lines
10 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.gitee.io/vue-element-admin-site/zh/donate">
  24. <img src="https://img.shields.io/badge/%24-donate-ff69b4.svg" alt="donate">
  25. </a>
  26. </p>
  27. 简体中文 | [English](./README.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. ## 简介
  37. [vue-element-admin](https://panjiachen.github.io/vue-element-admin) 是一个后台前端解决方案,它基于 [vue](https://github.com/vuejs/vue) 和 [element-ui](https://github.com/ElemeFE/element)实现。它使用了最新的前端技术栈,内置了 i18n 国际化解决方案,动态路由,权限验证,提炼了典型的业务模型,提供了丰富的功能组件,它可以帮助你快速搭建企业级中后台产品原型。相信不管你的需求是什么,本项目都能帮助到你。
  38. - [在线预览](https://panjiachen.github.io/vue-element-admin)
  39. - [使用文档](https://panjiachen.github.io/vue-element-admin-site/zh/)
  40. - [Gitter 讨论组](https://gitter.im/vue-element-admin/discuss)
  41. - [Donate](https://panjiachen.gitee.io/vue-element-admin-site/zh/donate)
  42. - [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
  43. - [Gitee](https://panjiachen.gitee.io/vue-element-admin/) 在线预览(国内用户可访问该地址)
  44. - [国内访问文档](https://panjiachen.gitee.io/vue-element-admin-site/zh/) 文档(方便没翻墙的用户查看)
  45. - 基础模板建议使用: [vue-admin-template](https://github.com/PanJiaChen/vue-admin-template)
  46. - Typescript 版: [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (鸣谢: [@Armour](https://github.com/Armour))
  47. - [awesome-project](https://github.com/PanJiaChen/vue-element-admin/issues/2312)
  48. **`v4.1.0+`版本之后默认 master 分支将不支持国际化,有需要的请使用[i18n](https://github.com/PanJiaChen/vue-element-admin/tree/i18n)分支,它会和 master 保持同步更新**
  49. **该项目不支持低版本浏览器(如 ie),有需求请自行添加 polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**
  50. **目前版本为 `v4.0+` 基于 `vue-cli` 进行构建,若发现问题,欢迎提[issue](https://github.com/PanJiaChen/vue-element-admin/issues/new)。若你想使用旧版本,可以切换分支到[tag/3.11.0](https://github.com/PanJiaChen/vue-element-admin/tree/tag/3.11.0),它不依赖 `vue-cli`**
  51. 群主 **[圈子](https://jianshiapp.com/circles/1209)** 群主会经常分享一些技术相关的东西,或者加入 [qq 群](https://github.com/PanJiaChen/vue-element-admin/issues/602) 或者关注 [微博](https://weibo.com/u/3423485724?is_all=1)
  52. ## 前序准备
  53. 你需要在本地安装 [node](http://nodejs.org/) 和 [git](https://git-scm.com/)。本项目技术栈基于 [ES2015+](http://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) 和 [element-ui](https://github.com/ElemeFE/element),所有的请求数据都使用[Mock.js](https://github.com/nuysoft/Mock)进行模拟,提前了解和学习这些知识会对使用本项目有很大的帮助。
  54. 同时配套了系列教程文章,如何从零构建后一个完整的后台项目,建议大家先看完这些文章再来实践本项目
  55. - [手摸手,带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2)
  56. - [手摸手,带你用 vue 撸后台 系列二(登录权限篇)](https://juejin.im/post/591aa14f570c35006961acac)
  57. - [手摸手,带你用 vue 撸后台 系列三 (实战篇)](https://juejin.im/post/593121aa0ce4630057f70d35)
  58. - [手摸手,带你用 vue 撸后台 系列四(vueAdmin 一个极简的后台基础模板)](https://juejin.im/post/595b4d776fb9a06bbe7dba56)
  59. - [手摸手,带你用vue撸后台 系列五(v4.0新版本)](https://juejin.im/post/5c92ff94f265da6128275a85)
  60. - [手摸手,带你封装一个 vue component](https://segmentfault.com/a/1190000009090836)
  61. - [手摸手,带你优雅的使用 icon](https://juejin.im/post/59bb864b5188257e7a427c09)
  62. - [手摸手,带你用合理的姿势使用 webpack4(上)](https://juejin.im/post/5b56909a518825195f499806)
  63. - [手摸手,带你用合理的姿势使用 webpack4(下)](https://juejin.im/post/5b5d6d6f6fb9a04fea58aabc)
  64. **如有问题请先看上述使用文档和文章,若不能满足,欢迎 issue 和 pr**
  65. [![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/PanJiaChen/vue-element-admin/tree/CodeSandbox)
  66. <p align="center">
  67. <img width="900" src="https://wpimg.wallstcn.com/a5894c1b-f6af-456e-82df-1151da0839bf.png">
  68. </p>
  69. ## Sponsors
  70. 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)
  71. ### Akveo
  72. <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>Java 后端整合,可以使用优惠码:SWB0RAZPZR1M,获得20%的价格优化</p>
  73. ### Flatlogic
  74. <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>
  75. ## 功能
  76. ```
  77. - 登录 / 注销
  78. - 权限验证
  79. - 页面权限
  80. - 指令权限
  81. - 权限配置
  82. - 二步登录
  83. - 多环境发布
  84. - dev
  85. - sit
  86. - stage
  87. - prod
  88. - 全局功能
  89. - 国际化多语言
  90. - 多种动态换肤
  91. - 动态侧边栏(支持多级路由嵌套)
  92. - 动态面包屑
  93. - 快捷导航(标签页)
  94. - Svg Sprite 图标
  95. - 本地/后端 mock 数据
  96. - Screenfull全屏
  97. - 自适应收缩侧边栏
  98. - 编辑器
  99. - 富文本
  100. - Markdown
  101. - JSON 等多格式
  102. - Excel
  103. - 导出excel
  104. - 导入excel
  105. - 前端可视化excel
  106. - 导出zip
  107. - 表格
  108. - 动态表格
  109. - 拖拽表格
  110. - 内联编辑
  111. - 错误页面
  112. - 401
  113. - 404
  114. - 組件
  115. - 头像上传
  116. - 返回顶部
  117. - 拖拽Dialog
  118. - 拖拽Select
  119. - 拖拽看板
  120. - 列表拖拽
  121. - SplitPane
  122. - Dropzone
  123. - Sticky
  124. - CountTo
  125. - 综合实例
  126. - 错误日志
  127. - Dashboard
  128. - 引导页
  129. - ECharts 图表
  130. - Clipboard(剪贴复制)
  131. - Markdown2html
  132. ```
  133. ## 开发
  134. ```bash
  135. # 克隆项目
  136. git clone https://github.com/PanJiaChen/vue-element-admin.git
  137. # 进入项目目录
  138. cd vue-element-admin
  139. # 安装依赖
  140. npm install
  141. # 建议不要直接使用 cnpm 安装依赖,会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
  142. npm install --registry=https://registry.npm.taobao.org
  143. # 启动服务
  144. npm run dev
  145. ```
  146. 浏览器访问 http://localhost:9527
  147. ## 发布
  148. ```bash
  149. # 构建测试环境
  150. npm run build:stage
  151. # 构建生产环境
  152. npm run build:prod
  153. ```
  154. ## 其它
  155. ```bash
  156. # 预览发布环境效果
  157. npm run preview
  158. # 预览发布环境效果 + 静态资源分析
  159. npm run preview -- --report
  160. # 代码格式检查
  161. npm run lint
  162. # 代码格式检查并自动修复
  163. npm run lint -- --fix
  164. ```
  165. 更多信息请参考 [使用文档](https://panjiachen.github.io/vue-element-admin-site/zh/)
  166. ## Changelog
  167. Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).
  168. ## Online Demo
  169. [在线 Demo](https://panjiachen.github.io/vue-element-admin)
  170. ## Donate
  171. 如果你觉得这个项目帮助到了你,你可以帮作者买一杯果汁表示鼓励 :tropical_drink:
  172. ![donate](https://panjiachen.github.io/donate/donation.png)
  173. [更多捐赠方式](https://panjiachen.gitee.io/vue-element-admin-site/zh/donate)
  174. [Paypal Me](https://www.paypal.me/panfree23)
  175. [Buy me a coffee](https://www.buymeacoffee.com/Pan)
  176. ## 购买贴纸
  177. 你也可以通过 购买[官方授权的贴纸](https://smallsticker.com/product/vue-element-admin) 的方式来支持 vue-element-admin - 每售出一张贴纸,本项目将获得 2 元的捐赠。
  178. ## Browsers support
  179. Modern browsers and Internet Explorer 10+.
  180. | [<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 |
  181. | --------- | --------- | --------- | --------- |
  182. | IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions |
  183. ## License
  184. [MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)
  185. Copyright (c) 2017-present PanJiaChen