README.md 6.77 KB
Newer Older
花裤衩's avatar
花裤衩 committed
1
<p align="center">
花裤衩's avatar
花裤衩 committed
2
  <img width="320" src="https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg">
花裤衩's avatar
花裤衩 committed
3
4
</p>

Pan's avatar
Pan committed
5
# vue-element-admin
花裤衩's avatar
花裤衩 committed
6

7
8
[![vue](https://img.shields.io/badge/vue-2.5.10-brightgreen.svg)](https://github.com/vuejs/vue)
[![element-ui](https://img.shields.io/badge/element--ui-2.0.8-brightgreen.svg)](https://github.com/ElemeFE/element)
花裤衩's avatar
花裤衩 committed
9
[![Build Status](https://travis-ci.org/PanJiaChen/vue-element-admin.svg?branch=master)](https://travis-ci.org/PanJiaChen/vue-element-admin)
花裤衩's avatar
花裤衩 committed
10
11
12
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/PanJiaChen/vue-element-admin.svg)]()

Pan's avatar
Pan committed
13
**A magical vue admin.**
花裤衩's avatar
花裤衩 committed
14

Pan's avatar
Pan committed
15
- [线上地址](http://panjiachen.github.io/vue-element-admin)
Pan's avatar
refine    
Pan committed
16

Pan's avatar
Pan committed
17
- [使用文档](https://panjiachen.github.io/vue-element-admin-site/#/)
Pan's avatar
Pan committed
18

Pan's avatar
Pan committed
19
- [English Document](https://github.com/PanJiaChen/vue-element-admin/blob/master/README-en.md)
Pan's avatar
refine    
Pan committed
20

Pan's avatar
Pan committed
21
22
23
- [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)

- [donate](https://panjiachen.github.io/vue-element-admin-site/#/donate)
花裤衩's avatar
花裤衩 committed
24

Pan's avatar
Pan committed
25
26
27
**本项目的定位是后台集成方案,不适合当基础模板来开发。**
 - 模板建议使用: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)  
 - 桌面端: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
花裤衩's avatar
花裤衩 committed
28

29
**注意:该项目使用 element-ui@2.0.0+ 版本,所以最低兼容 vue@2.5.0**
花裤衩's avatar
花裤衩 committed
30

Pan's avatar
Pan committed
31
## 前序准备
ttop5's avatar
ttop5 committed
32

Pan's avatar
Pan committed
33
你的本地环境需要安装 [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/)[element-ui](https://github.com/ElemeFE/element),提前了解和学习这些知识会对使用本项目有很大的帮助。
Pan's avatar
Pan committed
34

Pan's avatar
Pan committed
35
同时配套一个系列的教程文章,如何从零构建后一个完整的后台项目,建议大家先看完这些文章再来实践本项目
Pan's avatar
Pan committed
36
37
 - [手摸手,带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2)
 - [手摸手,带你用 vue 撸后台 系列二(登录权限篇)](https://juejin.im/post/591aa14f570c35006961acac)
Pan's avatar
Pan committed
38
 - [手摸手,带你用 vue 撸后台 系列三 (实战篇)](https://juejin.im/post/593121aa0ce4630057f70d35)
Pan's avatar
Pan committed
39
40
41
 - [手摸手,带你用 vue 撸后台 系列四(vueAdmin 一个极简的后台基础模板)](https://juejin.im/post/595b4d776fb9a06bbe7dba56)
 - [手摸手,带你封装一个 vue component](https://segmentfault.com/a/1190000009090836)
 - [手摸手,带你优雅的使用 icon](https://juejin.im/post/59bb864b5188257e7a427c09)
Pan's avatar
refine    
Pan committed
42

43
 响应需求,开了一个qq群 `591724180` 方便大家交流
Pan's avatar
Pan committed
44

45
 或者加入该群主 **[圈子](https://jianshiapp.com/circles/1209)** 楼主会经常分享一些技术相关的东西
Pan's avatar
Pan committed
46

Pan's avatar
Pan committed
47
 **如有问题请先看上述使用文档和文章,若不能满足,欢迎 issue 和 pr**
Pan's avatar
Pan committed
48

Pan's avatar
Pan committed
49
 **本项目并不是一个脚手架,更倾向于是一个集成解决方案**
Pan's avatar
Pan committed
50

Pan's avatar
Pan committed
51
 **该项目不支持低版本游览器(如ie),有需求请自行添加polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**
Pan's avatar
Pan committed
52

53
54
55
 <p align="center">
  <img width="900" src="https://wpimg.wallstcn.com/a5894c1b-f6af-456e-82df-1151da0839bf.png">
</p>
Pan's avatar
refine    
Pan committed
56
57
58
59

## 功能
- 登录/注销
- 权限验证
Pan's avatar
Pan committed
60
61
62
63
64
- 多环境发布
- 动态侧边栏(支持多级路由)
- 动态面包屑
- 国际化多语言
- 多种动态换肤
Pan's avatar
Pan committed
65
- 快捷导航(标签页 支持右键操作)
Pan's avatar
refine    
Pan committed
66
67
68
- 富文本编辑器
- Markdown编辑器
- JSON编辑器
Pan's avatar
Pan committed
69
- Screenfull全屏
Pan's avatar
refine    
Pan committed
70
- 列表拖拽
Pan's avatar
Pan committed
71
72
73
74
75
76
- Svg Sprite 图标
- Dashboard
- 本地mock数据
- Echarts 图表
- Clipboard(剪贴复制)
- 401/404错误页面
Pan's avatar
refine    
Pan committed
77
78
- 错误日志
- 导出excel
Pan's avatar
Pan committed
79
- 导出zip
Pan's avatar
Pan committed
80
- 前端可视化excel
Pan's avatar
Pan committed
81
- Table example
Pan's avatar
Pan committed
82
83
- 动态table example
- 拖拽table example
Pan's avatar
Pan committed
84
- 内联编辑table example
Pan's avatar
Pan committed
85
86
87
88
89
90
- Form example
- 二步登录
- SplitPane
- Dropzone
- Sticky
- CountTo
91
- Markdown to html
Pan's avatar
refine    
Pan committed
92
93

## 开发
Pan's avatar
refine    
Pan committed
94
```bash
95
96
	# 克隆项目
	git clone https://github.com/PanJiaChen/vue-element-admin.git
Pan's avatar
refine    
Pan committed
97

98
99
100
101
102
	# 安装依赖
	npm install
	   
	# 建议不要用cnpm安装 会有各种诡异的bug 可以通过如下操作解决 npm 下载速度慢的问题
	npm install --registry=https://registry.npm.taobao.org
Pan's avatar
refine    
Pan committed
103

104
105
	# 启动服务
	npm run dev
Pan's avatar
refine    
Pan committed
106
```
Pan's avatar
refine    
Pan committed
107
108
109
浏览器访问 http://localhost:9527

## 发布
Pan's avatar
Pan committed
110
```bash
111
112
113
114
115
116
117
118
119
120
121
122
123
124
	# 构建测试环境
	npm run build:sit

	# 构建生成环境
	npm run build:prod
```

## 其它
```bash
	# --report to build with bundle size analytics
	npm run build:prod --report

	# --preview to start a server in local to preview
	npm run build:prod --preview
Pan's avatar
refine    
Pan committed
125

126
127
	# lint code
	npm run lint
Pan's avatar
Pan committed
128
129
```

130
更多信息请参考 [使用文档](https://panjiachen.github.io/vue-element-admin-site/#/deploy)
Pan's avatar
Pan committed
131

Pan's avatar
refine    
Pan committed
132
133
134
135
136
## 目录结构
```shell
├── build                      // 构建相关  
├── config                     // 配置相关
├── src                        // 源代码
Pan's avatar
refine    
Pan committed
137
│   ├── api                    // 所有请求
138
│   ├── assets                 // 主题 图片等静态资源
Pan's avatar
refine    
Pan committed
139
140
│   ├── components             // 全局公用组件
│   ├── directive              // 全局指令
Pan's avatar
Pan committed
141
│   ├── filtres                // 全局 filter
142
143
│   ├── icons                  // 项目svg icons
│   ├── lang                   // 国际化 lang
Pan's avatar
Pan committed
144
│   ├── mock                   // 项目mock 模拟数据
Pan's avatar
refine    
Pan committed
145
│   ├── router                 // 路由
146
│   ├── store                  // 全局 store
Pan's avatar
refine    
Pan committed
147
148
│   ├── styles                 // 全局样式
│   ├── utils                  // 全局公用方法
Pan's avatar
Pan committed
149
│   ├── vendor                 // 公用vendor
150
│   ├── views                  // views
Pan's avatar
refine    
Pan committed
151
│   ├── App.vue                // 入口页面
152
│   ├── main.js                // 入口js 初始化 加载组件等
Pan's avatar
Pan committed
153
│   └── permission.js          // 权限管理
Pan's avatar
refine    
Pan committed
154
155
156
├── static                     // 第三方不打包资源
│   └── Tinymce                // 富文本
├── .babelrc                   // babel-loader 配置
157
158
├── .eslintrc.js               // eslint 配置项
├── .postcssrc.js              // postcss 配置项
Pan's avatar
refine    
Pan committed
159
160
161
162
163
164
165
├── .gitignore                 // git 忽略项
├── favicon.ico                // favicon图标
├── index.html                 // html模板
└── package.json               // package.json

```

Pan's avatar
Pan committed
166
167
168
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).

169
170
## Online Demo
[查看更多demo](http://panjiachen.github.io/vue-element-admin)
Pan's avatar
Pan committed
171
172
173
174

## Donate
If you find this project useful, you can buy me a cup of coffee
![donate](https://panjiachen.github.io/donate/donation.png)
花裤衩's avatar
花裤衩 committed
175
176
177
178

## License

MIT