README.zh-CN.md 11.3 KB
Newer Older
花裤衩 已提交
1 2 3 4 5
<p align="center">
  <img width="320" src="https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg">
</p>

<p align="center">
6
  <a href="https://github.com/vuejs/vue">
花裤衩 已提交
7
    <img src="https://img.shields.io/badge/vue-2.6.10-brightgreen.svg" alt="vue">
8 9
  </a>
  <a href="https://github.com/ElemeFE/element">
花裤衩 已提交
10
    <img src="https://img.shields.io/badge/element--ui-2.7.0-brightgreen.svg" alt="element-ui">
11 12 13 14 15 16 17 18 19 20
  </a>
  <a href="https://travis-ci.org/PanJiaChen/vue-element-admin" rel="nofollow">
    <img src="https://travis-ci.org/PanJiaChen/vue-element-admin.svg?branch=master" alt="Build Status">
  </a>
  <a href="https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE">
    <img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="license">
  </a>
  <a href="https://github.com/PanJiaChen/vue-element-admin/releases">
    <img src="https://img.shields.io/github/release/PanJiaChen/vue-element-admin.svg" alt="GitHub release">
  </a>
P
docs  
Pan 已提交
21 22 23 24 25 26
  <a href="https://gitter.im/vue-element-admin/discuss">
    <img src="https://badges.gitter.im/Join%20Chat.svg" alt="gitter">
  </a>
  <a href="https://panjiachen.gitee.io/vue-element-admin-site/zh/donate">
    <img src="https://img.shields.io/badge/%24-donate-ff69b4.svg" alt="donate">
  </a>
花裤衩 已提交
27 28
</p>

29
简体中文 | [English](./README.md) | [日本語](./README.ja.md) | [Spanish](./README.es.md)
花裤衩 已提交
30

花裤衩 已提交
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
<p align="center">
  <b>SPONSORED BY</b>
</p>
<table align="center" cellspacing="0" cellpadding="0">
  <tbody>
    <tr>
      <td align="center" valign="middle" width="250">
        <a href="https://www.duohui.cn/?utm_source=vue-element-admin&utm_medium=web&utm_campaign=vue-element-admin_github" title="多会" target="_blank">
          <img height="60px" src="https://qiniu.cdn.duohui.co/brand/duohui.png" title="多会 - 活动服务销售平台">
          <p>活动服务销售平台</p>
        </a>
      </td>
      <td align="center" valign="middle" width="250">
        <a href="https://youke.co/?utm_source=vue-element-admin&utm_medium=web&utm_campaign=vue-element-admin_github" title="有客" target="_blank">
          <img height="60px" src="https://qiniu.cdn.duohui.co/brand/youke.png" title="有客 - 客户消息直达工作群">
          <p>客户消息直达工作群</p>
        </a>
      </td>
    </tr>
  </tbody>
</table>

花裤衩 已提交
53 54
## 简介

P
Pan 已提交
55
[vue-element-admin](https://panjiachen.github.io/vue-element-admin) 是一个后台前端解决方案,它基于 [vue](https://github.com/vuejs/vue)[element-ui](https://github.com/ElemeFE/element)实现。它使用了最新的前端技术栈,内置了 i18n 国际化解决方案,动态路由,权限验证,提炼了典型的业务模型,提供了丰富的功能组件,它可以帮助你快速搭建企业级中后台产品原型。相信不管你的需求是什么,本项目都能帮助到你。
花裤衩 已提交
56

P
Pan 已提交
57
- [在线预览](https://panjiachen.github.io/vue-element-admin)
花裤衩 已提交
58

P
Pan 已提交
59
- [使用文档](https://panjiachen.github.io/vue-element-admin-site/zh/)
花裤衩 已提交
60

P
Pan 已提交
61
- [Gitter 讨论组](https://gitter.im/vue-element-admin/discuss)
P
Pan 已提交
62

P
Pan 已提交
63
- [Donate](https://panjiachen.gitee.io/vue-element-admin-site/zh/donate)
花裤衩 已提交
64

花裤衩 已提交
65
- [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
P
Pan 已提交
66

花裤衩 已提交
67
- [Gitee](https://panjiachen.gitee.io/vue-element-admin/) 在线预览(国内用户可访问该地址)
P
docs  
Pan 已提交
68

花裤衩 已提交
69
- [国内访问文档](https://panjiachen.gitee.io/vue-element-admin-site/zh/) 文档(方便没翻墙的用户查看)
花裤衩 已提交
70

花裤衩 已提交
71
- 基础模板建议使用: [vue-admin-template](https://github.com/PanJiaChen/vue-admin-template)
P
Pan 已提交
72
- 桌面端: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
花裤衩 已提交
73
- Typescript 版: [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (鸣谢: [@Armour](https://github.com/Armour))
花裤衩 已提交
74
- [awesome-project](https://github.com/PanJiaChen/vue-element-admin/issues/2312)
花裤衩 已提交
75

花裤衩 已提交
76
**`v4.1.0+`版本之后默认 master 分支将不支持国际化,有需要的请使用[i18n](https://github.com/PanJiaChen/vue-element-admin/tree/i18n)分支,它会和 master 保持同步更新**
花裤衩 已提交
77

P
Pan 已提交
78 79
**该项目不支持低版本浏览器(如 ie),有需求请自行添加 polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**

花裤衩 已提交
80 81
**目前版本为 `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`**

花裤衩 已提交
82 83
群主 **[圈子](https://jianshiapp.com/circles/1209)** 群主会经常分享一些技术相关的东西,或者加入 [qq 群](https://github.com/PanJiaChen/vue-element-admin/issues/602) 或者关注 [微博](https://weibo.com/u/3423485724?is_all=1)

P
Pan 已提交
84 85
## 前序准备

花裤衩 已提交
86
你需要在本地安装 [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)进行模拟,提前了解和学习这些知识会对使用本项目有很大的帮助。
P
Pan 已提交
87

花裤衩 已提交
88
同时配套了系列教程文章,如何从零构建后一个完整的后台项目,建议大家先看完这些文章再来实践本项目
P
Pan 已提交
89

P
Pan 已提交
90 91 92 93
- [手摸手,带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2)
- [手摸手,带你用 vue 撸后台 系列二(登录权限篇)](https://juejin.im/post/591aa14f570c35006961acac)
- [手摸手,带你用 vue 撸后台 系列三 (实战篇)](https://juejin.im/post/593121aa0ce4630057f70d35)
- [手摸手,带你用 vue 撸后台 系列四(vueAdmin 一个极简的后台基础模板)](https://juejin.im/post/595b4d776fb9a06bbe7dba56)
P
Pan 已提交
94
- [手摸手,带你用vue撸后台 系列五(v4.0新版本)](https://juejin.im/post/5c92ff94f265da6128275a85)
P
Pan 已提交
95 96 97 98
- [手摸手,带你封装一个 vue component](https://segmentfault.com/a/1190000009090836)
- [手摸手,带你优雅的使用 icon](https://juejin.im/post/59bb864b5188257e7a427c09)
- [手摸手,带你用合理的姿势使用 webpack4(上)](https://juejin.im/post/5b56909a518825195f499806)
- [手摸手,带你用合理的姿势使用 webpack4(下)](https://juejin.im/post/5b5d6d6f6fb9a04fea58aabc)
花裤衩 已提交
99

花裤衩 已提交
100 101
**如有问题请先看上述使用文档和文章,若不能满足,欢迎 issue 和 pr**

102 103
[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/PanJiaChen/vue-element-admin/tree/CodeSandbox)

104
<p align="center">
花裤衩 已提交
105 106 107
  <img width="900" src="https://wpimg.wallstcn.com/a5894c1b-f6af-456e-82df-1151da0839bf.png">
</p>

P
Pan 已提交
108
## Sponsors
花裤衩 已提交
109

P
Pan 已提交
110 111
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)

112
### Akveo
花裤衩 已提交
113
<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>
114 115 116

### Flatlogic

P
Pan 已提交
117 118
<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>

花裤衩 已提交
119

花裤衩 已提交
120
## 功能
P
Pan 已提交
121

花裤衩 已提交
122
```
P
Pan 已提交
123 124
- 登录 / 注销

花裤衩 已提交
125
- 权限验证
P
Pan 已提交
126 127
  - 页面权限
  - 指令权限
花裤衩 已提交
128
  - 权限配置
P
Pan 已提交
129 130
  - 二步登录

花裤衩 已提交
131
- 多环境发布
132 133 134 135
  - dev
  - sit
  - stage
  - prod
P
Pan 已提交
136 137 138 139 140 141 142 143

- 全局功能
  - 国际化多语言
  - 多种动态换肤
  - 动态侧边栏(支持多级路由嵌套)
  - 动态面包屑
  - 快捷导航(标签页)
  - Svg Sprite 图标
花裤衩 已提交
144
  - 本地/后端 mock 数据
P
Pan 已提交
145 146 147 148 149 150 151 152 153 154 155 156
  - Screenfull全屏
  - 自适应收缩侧边栏

- 编辑器
  - 富文本
  - Markdown
  - JSON 等多格式

- Excel
  - 导出excel
  - 导入excel
  - 前端可视化excel
花裤衩 已提交
157
  - 导出zip
P
Pan 已提交
158 159 160 161 162 163 164 165 166 167 168 169 170 171

- 表格
  - 动态表格
  - 拖拽表格
  - 内联编辑

- 错误页面
  - 401
  - 404

- 組件
  - 头像上传
  - 返回顶部
  - 拖拽Dialog
172
  - 拖拽Select
P
Pan 已提交
173 174 175 176 177 178 179 180 181
  - 拖拽看板
  - 列表拖拽
  - SplitPane
  - Dropzone
  - Sticky
  - CountTo

- 综合实例
- 错误日志
花裤衩 已提交
182
- Dashboard
花裤衩 已提交
183
- 引导页
P
Pan 已提交
184
- ECharts 图表
花裤衩 已提交
185 186 187 188 189
- Clipboard(剪贴复制)
- Markdown2html
```

## 开发
P
Pan 已提交
190

花裤衩 已提交
191 192 193 194
```bash
# 克隆项目
git clone https://github.com/PanJiaChen/vue-element-admin.git

花裤衩 已提交
195 196 197
# 进入项目目录
cd vue-element-admin

花裤衩 已提交
198 199
# 安装依赖
npm install
P
Pan 已提交
200

201
# 建议不要直接使用 cnpm 安装依赖,会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
花裤衩 已提交
202 203 204 205 206
npm install --registry=https://registry.npm.taobao.org

# 启动服务
npm run dev
```
P
Pan 已提交
207

花裤衩 已提交
208 209 210
浏览器访问 http://localhost:9527

## 发布
P
Pan 已提交
211

花裤衩 已提交
212 213
```bash
# 构建测试环境
花裤衩 已提交
214
npm run build:stage
花裤衩 已提交
215

I
iGoo丶 已提交
216
# 构建生产环境
花裤衩 已提交
217 218 219 220
npm run build:prod
```

## 其它
P
Pan 已提交
221

花裤衩 已提交
222
```bash
花裤衩 已提交
223 224
# 预览发布环境效果
npm run preview
花裤衩 已提交
225

花裤衩 已提交
226 227
# 预览发布环境效果 + 静态资源分析
npm run preview -- --report
花裤衩 已提交
228

花裤衩 已提交
229
# 代码格式检查
花裤衩 已提交
230 231
npm run lint

花裤衩 已提交
232
# 代码格式检查并自动修复
花裤衩 已提交
233 234 235
npm run lint -- --fix
```

P
Pan 已提交
236
更多信息请参考 [使用文档](https://panjiachen.github.io/vue-element-admin-site/zh/)
花裤衩 已提交
237 238

## Changelog
P
Pan 已提交
239

花裤衩 已提交
240 241 242
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).

## Online Demo
P
Pan 已提交
243

P
Pan 已提交
244
[在线 Demo](https://panjiachen.github.io/vue-element-admin)
花裤衩 已提交
245 246

## Donate
P
Pan 已提交
247

花裤衩 已提交
248 249 250
如果你觉得这个项目帮助到了你,你可以帮作者买一杯果汁表示鼓励 :tropical_drink:
![donate](https://panjiachen.github.io/donate/donation.png)

P
Pan 已提交
251 252
[更多捐赠方式](https://panjiachen.gitee.io/vue-element-admin-site/zh/donate)

花裤衩 已提交
253 254
[Paypal Me](https://www.paypal.me/panfree23)

花裤衩 已提交
255 256
[Buy me a coffee](https://www.buymeacoffee.com/Pan)

花裤衩 已提交
257 258
## 购买贴纸

花裤衩 已提交
259
你也可以通过 购买[官方授权的贴纸](https://smallsticker.com/product/vue-element-admin) 的方式来支持 vue-element-admin - 每售出一张贴纸,本项目将获得 2 元的捐赠。
花裤衩 已提交
260

P
Pan 已提交
261 262 263 264
## Browsers support

Modern browsers and Internet Explorer 10+.

P
Pan 已提交
265
| [<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 |
P
Pan 已提交
266
| --------- | --------- | --------- | --------- |
267
| IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions |
P
Pan 已提交
268

花裤衩 已提交
269 270 271 272
## License

[MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)

P
Pan 已提交
273
Copyright (c) 2017-present PanJiaChen