README.md 6.37 KB
Newer Older
Pan's avatar
Pan committed
1
# vue-element-admin #
Pan's avatar
refine    
Pan committed
2
3
[线上地址](http://panjiachen.github.io/vue-element-admin)

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

Pan's avatar
refine    
Pan committed
6
7
[wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)

花裤衩's avatar
花裤衩 committed
8
9
**本项目的定位是后台集成方案,不适合当基础模板来开发,模板建议使用 [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)**

ttop5's avatar
ttop5 committed
10
**注意:该项目目前使用element-ui@1.3.3版本,所以最低兼容 Vue 2.3.0**
Pan's avatar
Pan committed
11

Pan's avatar
refine    
Pan committed
12
## 前言
ttop5's avatar
ttop5 committed
13
14
> 这半年来一直在用vue写管理后台,目前后台已经有百来个页面,十几种权限,但维护成本依然很低,所以准备开源分享一下后台开发的经验和成果。目前的技术栈主要的采用vue+element+axios由webpack2打包。由于是个人项目,所以数据请求都是用了mockjs模拟。注意:在此项目基础上改造开发时请移除mock文件。

Pan's avatar
Pan committed
15

Pan's avatar
Pan committed
16
写了一个系列的教程配套文章,如何从零构建后一个完整的后台项目:
Pan's avatar
Pan committed
17

Pan's avatar
refine    
Pan committed
18
 - [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
Pan's avatar
Pan committed
19
20
 - [手摸手,带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2)
 - [手摸手,带你用 vue 撸后台 系列二(登录权限篇)](https://juejin.im/post/591aa14f570c35006961acac)
Pan's avatar
Pan committed
21
 - [手摸手,带你用 vue 撸后台 系列三 (实战篇)](https://juejin.im/post/593121aa0ce4630057f70d35)
花裤衩's avatar
花裤衩 committed
22
 - [手摸手,带你用vue撸后台 系列四(vueAdmin 一个极简的后台基础模板)](https://juejin.im/post/595b4d776fb9a06bbe7dba56)
Pan's avatar
Pan committed
23
 - [手摸手,带你封装一个vue component](https://segmentfault.com/a/1190000009090836)
Pan's avatar
refine    
Pan committed
24

ttop5's avatar
ttop5 committed
25
 相应需求,开了一个qq群 `591724180` 方便大家交流
Pan's avatar
Pan committed
26

ttop5's avatar
ttop5 committed
27
 **如有问题请先看上述文章和Wiki,若不能满足,欢迎issue和pr~**
Pan's avatar
Pan committed
28

ttop5's avatar
ttop5 committed
29
 **该项目并不是一个脚手架,更倾向于是一个集成解决方案**
Pan's avatar
Pan committed
30

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

Pan's avatar
refine    
Pan committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

## 功能
- 登录/注销
- 权限验证
- 侧边栏
- 面包屑
- 富文本编辑器
- Markdown编辑器
- JSON编辑器
- 列表拖拽
- plitPane
- Dropzone
- Sticky
- CountTo
- echarts图表
- 401,401错误页面
- 错误日志
- 导出excel
- table example
Pan's avatar
Pan committed
52
53
- 动态table example
- 拖拽table example
Pan's avatar
Pan committed
54
- 内联编辑table example
Pan's avatar
refine    
Pan committed
55
56
57
58
- form example
- 多环境发布
- dashboard
- 二次登录
Pan's avatar
Pan committed
59
- 动态侧边栏(支持多级路由)
Pan's avatar
refine    
Pan committed
60
- mock数据
Pan's avatar
Pan committed
61
62
63
- cache tabs example
- screenfull
- markdown2html
Pan's avatar
Pan committed
64
- views-tab
Pan's avatar
refine    
Pan committed
65
66
67


## 开发
Pan's avatar
refine    
Pan committed
68
```bash
Pan's avatar
Pan committed
69
    # 克隆项目
Pan's avatar
refine    
Pan committed
70
71
    git clone https://github.com/PanJiaChen/vue-element-admin.git

Pan's avatar
Pan committed
72
73
    # 安装依赖
    npm install
Pan's avatar
Pan committed
74
    //or # 建议不要用cnpm  安装有各种诡异的bug 可以通过如下操作解决npm速度慢的问题
Pan's avatar
Pan committed
75
    npm install --registry=https://registry.npm.taobao.org
Pan's avatar
refine    
Pan committed
76
77

    # 本地开发 开启服务
Pan's avatar
Pan committed
78
    npm run dev
Pan's avatar
refine    
Pan committed
79
```
Pan's avatar
refine    
Pan committed
80
81
82
浏览器访问 http://localhost:9527

## 发布
Pan's avatar
Pan committed
83
```bash
Pan's avatar
Pan committed
84
85
    # 发布测试环境 带webpack ananalyzer
    npm run build:sit-preview
Pan's avatar
refine    
Pan committed
86

Pan's avatar
Pan committed
87
88
    # 构建生成环境
    npm run build:prod
Pan's avatar
Pan committed
89
90
```

Pan's avatar
refine    
Pan committed
91
92
93
94
95
## 目录结构
```shell
├── build                      // 构建相关  
├── config                     // 配置相关
├── src                        // 源代码
Pan's avatar
refine    
Pan committed
96
│   ├── api                    // 所有请求
Pan's avatar
refine    
Pan committed
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
│   ├── assets                 // 主题 字体等静态资源
│   ├── components             // 全局公用组件
│   ├── directive              // 全局指令
│   ├── filtres                // 全局filter
│   ├── mock                   // mock数据
│   ├── router                 // 路由
│   ├── store                  // 全局store管理
│   ├── styles                 // 全局样式
│   ├── utils                  // 全局公用方法
│   ├── view                   // view
│   ├── App.vue                // 入口页面
│   └── main.js                // 入口 加载组件 初始化等
├── static                     // 第三方不打包资源
│   ├── jquery
│   └── Tinymce                // 富文本
├── .babelrc                   // babel-loader 配置
├── eslintrc.js                // eslint 配置项
├── .gitignore                 // git 忽略项
├── favicon.ico                // favicon图标
├── index.html                 // html模板
└── package.json               // package.json

```

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

Pan's avatar
refine    
Pan committed
124
125
126
127
## 状态管理
后台只有user和app配置相关状态使用vuex存在全局,其它数据都由每个业务页面自己管理。


Pan's avatar
Pan committed
128
## 效果图
Pan's avatar
update    
Pan committed
129

Pan's avatar
update    
Pan committed
130
#### 两步验证登录 支持微信和qq
Pan's avatar
update    
Pan committed
131

Pan's avatar
Pan committed
132
133
![两步验证 here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/2login.gif)

Pan's avatar
update    
Pan committed
134
#### 真正的动态换肤
Pan's avatar
update    
Pan committed
135

Pan's avatar
Pan committed
136
137
![真正的动态换肤](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/theme.gif)<br />

Pan's avatar
Pan committed
138
139
140
141
#### tabs

![tabs](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/tabs.gif)<br />

Pan's avatar
Pan committed
142

Pan's avatar
Pan committed
143

Pan's avatar
update    
Pan committed
144
#### 可收起侧边栏
Pan's avatar
update    
Pan committed
145

Pan's avatar
Pan committed
146
147
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/leftmenu.gif)

Pan's avatar
Pan committed
148
#### table拖拽排序
Pan's avatar
update    
Pan committed
149

Pan's avatar
Pan committed
150
151
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/order.gif)

Pan's avatar
Pan committed
152

Pan's avatar
Pan committed
153
154
155
156
#### 动态table

![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/dynamictable.gif)

Pan's avatar
Pan committed
157

Pan's avatar
update    
Pan committed
158
#### 上传裁剪头像
Pan's avatar
update    
Pan committed
159

Pan's avatar
Pan committed
160
161
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/uploadAvatar.gif)

Pan's avatar
Pan committed
162

Pan's avatar
Pan committed
163
164
#### 错误统计

Pan's avatar
Pan committed
165
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/errorlog.gif)
Pan's avatar
Pan committed
166

Pan's avatar
Pan committed
167

Pan's avatar
update    
Pan committed
168
#### 富文本(整合七牛 打水印等个性化功能)
Pan's avatar
update    
Pan committed
169

Pan's avatar
Pan committed
170
171
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/editor.gif)

Pan's avatar
update    
Pan committed
172
#### 封装table组件
Pan's avatar
update    
Pan committed
173

Pan's avatar
Pan committed
174
175
176
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/table.gif)

#### 图表
Pan's avatar
update    
Pan committed
177

Pan's avatar
Pan committed
178
179
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/echarts.gif)

Pan's avatar
Pan committed
180

Pan's avatar
update    
Pan committed
181
#### 导出excel
Pan's avatar
update    
Pan committed
182

Pan's avatar
Pan committed
183
184
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/excel.png)

Pan's avatar
Pan committed
185
186

## [更多demo](http://panjiachen.github.io/vue-element-admin)