介绍

vueelement-uiBuild StatuslicenseGitHub releasedonateGitHub stars

vue-element-admin 是基于 Vue2.0,配合使用 Element UI 组件库的一个前端管理后台集成解决方案。它使用了最新的前端技术栈,提炼了典型的业务模型,提供了丰富的功能组件,它可以帮助你快速搭建企业级中后台产品原型。

建议

本项目的定位是后台集成方案,不适合当基础模板来进行二次开发。

功能

  1. - 登录 / 注销
  2. - 权限验证
  3. - 页面权限
  4. - 指令权限
  5. - 二步登录
  6. - 多环境发布
  7. - dev sit stage prod
  8. - 全局功能
  9. - 国际化多语言
  10. - 多种动态换肤
  11. - 动态侧边栏(支持多级路由嵌套)
  12. - 动态面包屑
  13. - 快捷导航(标签页)
  14. - Svg Sprite 图标
  15. - 本地mock数据
  16. - Screenfull全屏
  17. - 自适应收缩侧边栏
  18. - 编辑器
  19. - 富文本
  20. - Markdown
  21. - JSON 等多格式
  22. - Excel
  23. - 导出excel
  24. - 导出zip
  25. - 导入excel
  26. - 前端可视化excel
  27. - 表格
  28. - 动态表格
  29. - 拖拽表格
  30. - 树形表格
  31. - 内联编辑
  32. - 错误页面
  33. - 401
  34. - 404
  35. - 組件
  36. - 头像上传
  37. - 返回顶部
  38. - 拖拽Dialog
  39. - 拖拽看板
  40. - 列表拖拽
  41. - SplitPane
  42. - Dropzone
  43. - Sticky
  44. - CountTo
  45. - 综合实例
  46. - 错误日志
  47. - Dashboard
  48. - 引导页
  49. - ECharts 图表
  50. - Clipboard(剪贴复制)
  51. - Markdown to Html

前序准备

你需要在本地安装 nodegit。本项目技术栈基于 ES2015+vuevuexvue-routeraxioselement-ui,所有的请求数据都使用Mock.js模拟,提前了解和学习这些知识会对使用本项目有很大的帮助。

同时配套一个系列的教程文章,如何从零构建后一个完整的管理后台项目,建议大家先看完这些文章再来实践本项目。

注意:该项目使用 element-ui@2.3.0+ 版本,所以最低兼容 vue@2.5.0+

目录结构

本项目已经为你生成了一个完整的开发框架,提供了涵盖中后台开发的各类功能和坑位,下面是整个项目的目录结构。

  1. ├── build // 构建相关
  2. ├── config // 配置相关
  3. ├── src // 源代码
  4. ├── api // 所有请求
  5. ├── assets // 主题 字体等静态资源
  6. ├── components // 全局公用组件
  7. ├── directive // 全局指令
  8. ├── filters // 全局 filter
  9. ├── icons // 项目所有 svg icons
  10. ├── lang // 国际化 language
  11. ├── mock // 项目mock 模拟数据
  12. ├── router // 路由
  13. ├── store // 全局 store管理
  14. ├── styles // 全局样式
  15. ├── utils // 全局公用方法
  16. ├── vendor // 公用vendor
  17. ├── views // views 所有页面
  18. ├── App.vue // 入口页面
  19. ├── main.js // 入口文件 加载组件 初始化等
  20. └── permission.js // 权限管理
  21. ├── static // 第三方不打包资源
  22. └── Tinymce // 富文本
  23. ├── .babelrc // babel-loader 配置
  24. ├── .eslintrc.js // eslint 配置项
  25. ├── .gitignore // git 忽略项
  26. ├── .travis.yml // 自动化CI配置
  27. ├── favicon.ico // favicon图标
  28. ├── index.html // html模板
  29. └── package.json // package.json

安装

  1. # 克隆项目
  2. git clone https://github.com/PanJiaChen/vue-element-admin.git
  3. # 安装依赖
  4. npm install
  5. # 本地开发 启动项目
  6. npm run dev

TIP

强烈建议不要用直接使用 cnpm 安装,会有各种诡异的 bug,可以通过重新指定 registry 来解决 npm 安装速度慢的问题。若还是不行,可使用 yarn 替代 npm

Windows 用户若安装不成功,很大概率是node-sass安装失败,解决方案

  1. npm install --registry=https://registry.npm.taobao.org

启动完成后会自动打开浏览器访问 http://localhost:9527, 你看到下面的页面就代表操作成功了。

介绍 - 图8

接下来你可以修改代码进行业务开发了,我们内建了典型业务模板、常用业务组件、模拟数据、HMR 实时预览、状态管理、国际化、全局路由等等各种实用的功能来辅助开发,你可以继续阅读和探索左侧的其他文档。

建议

你可以把 vue-element-admin当做工具箱或者集成方案仓库,在 vue-admin-template 的基础上进行二次开发,想要什么功能或者组件就去 vue-element-admin 那里复制过来。

Contribution

本文档项目地址 vue-element-admin-site 基于 vuepress开发。

有任何修改和建议都可以该项目 pr 和 issue

vue-element-admin 还在持续迭代中,逐步沉淀和总结出更多功能和相应的实现代码,总结中后台产品模板/组件/业务场景的最佳实践。本项目也十分期待你的参与和反馈

捐赠

如果你觉得这个项目帮助到了你,你可以帮作者买一杯果汁表示鼓励 ❤️Donate

Browsers Support

Modern browsers and Internet Explorer 10+.

IE / EdgeIE / Edge FirefoxFirefox ChromeChrome SafariSafari
IE10, IE11, Edge last 2 versions last 2 versions last 2 versions

原文: https://panjiachen.github.io/vue-element-admin-site/zh/guide/