README.md 6.5 KB
Newer Older
P
Pan 已提交
1
# vue-element-admin #
P
refine  
Pan 已提交
2 3
[线上地址](http://panjiachen.github.io/vue-element-admin)

P
Pan 已提交
4 5
[English Document](https://github.com/PanJiaChen/vue-element-admin/blob/master/README-en.md)

P
refine  
Pan 已提交
6 7
[wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)

花裤衩 已提交
8 9 10
**本项目的定位是后台集成方案,不适合当基础模板来开发,模板建议使用 [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template) , 桌面端 [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)**


花裤衩 已提交
11

T
ttop5 已提交
12
**注意:该项目目前使用element-ui@1.3.3版本,所以最低兼容 Vue 2.3.0**
P
Pan 已提交
13

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

P
Pan 已提交
17

P
Pan 已提交
18
写了一个系列的教程配套文章,如何从零构建后一个完整的后台项目:
P
Pan 已提交
19

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

T
ttop5 已提交
27
 相应需求,开了一个qq群 `591724180` 方便大家交流
P
Pan 已提交
28

花裤衩 已提交
29
 **如有问题请先看上述文章和Wiki,若不能满足,欢迎 issue 和 pr ~**
P
Pan 已提交
30

T
ttop5 已提交
31
 **该项目并不是一个脚手架,更倾向于是一个集成解决方案**
P
Pan 已提交
32

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

P
refine  
Pan 已提交
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49

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


## 开发
P
refine  
Pan 已提交
70
```bash
P
Pan 已提交
71
    # 克隆项目
P
refine  
Pan 已提交
72 73
    git clone https://github.com/PanJiaChen/vue-element-admin.git

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

    # 本地开发 开启服务
P
Pan 已提交
80
    npm run dev
P
refine  
Pan 已提交
81
```
P
refine  
Pan 已提交
82 83 84
浏览器访问 http://localhost:9527

## 发布
P
Pan 已提交
85
```bash
P
Pan 已提交
86 87
    # 发布测试环境 带webpack ananalyzer
    npm run build:sit-preview
P
refine  
Pan 已提交
88

P
Pan 已提交
89 90
    # 构建生成环境
    npm run build:prod
P
Pan 已提交
91 92
```

P
refine  
Pan 已提交
93 94 95 96 97
## 目录结构
```shell
├── build                      // 构建相关  
├── config                     // 配置相关
├── src                        // 源代码
P
refine  
Pan 已提交
98
│   ├── api                    // 所有请求
P
refine  
Pan 已提交
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
│   ├── 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

```

P
Pan 已提交
123 124 125
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).

P
refine  
Pan 已提交
126 127 128 129
## 状态管理
后台只有user和app配置相关状态使用vuex存在全局,其它数据都由每个业务页面自己管理。


P
Pan 已提交
130
## 效果图
P
update  
Pan 已提交
131

P
update  
Pan 已提交
132
#### 两步验证登录 支持微信和qq
P
update  
Pan 已提交
133

P
Pan 已提交
134 135
![两步验证 here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/2login.gif)

P
update  
Pan 已提交
136
#### 真正的动态换肤
P
update  
Pan 已提交
137

P
Pan 已提交
138 139
![真正的动态换肤](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/theme.gif)<br />

P
Pan 已提交
140 141 142 143
#### tabs

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

P
Pan 已提交
144

P
Pan 已提交
145

P
update  
Pan 已提交
146
#### 可收起侧边栏
P
update  
Pan 已提交
147

P
Pan 已提交
148 149
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/leftmenu.gif)

P
Pan 已提交
150
#### table拖拽排序
P
update  
Pan 已提交
151

P
Pan 已提交
152 153
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/order.gif)

P
Pan 已提交
154

P
Pan 已提交
155 156 157 158
#### 动态table

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

P
Pan 已提交
159

P
update  
Pan 已提交
160
#### 上传裁剪头像
P
update  
Pan 已提交
161

P
Pan 已提交
162 163
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/uploadAvatar.gif)

P
Pan 已提交
164

P
Pan 已提交
165 166
#### 错误统计

P
Pan 已提交
167
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/errorlog.gif)
P
Pan 已提交
168

P
Pan 已提交
169

P
update  
Pan 已提交
170
#### 富文本(整合七牛 打水印等个性化功能)
P
update  
Pan 已提交
171

P
Pan 已提交
172 173
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/editor.gif)

P
update  
Pan 已提交
174
#### 封装table组件
P
update  
Pan 已提交
175

P
Pan 已提交
176 177 178
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/table.gif)

#### 图表
P
update  
Pan 已提交
179

P
Pan 已提交
180 181
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/echarts.gif)

P
Pan 已提交
182

P
update  
Pan 已提交
183
#### 导出excel
P
update  
Pan 已提交
184

P
Pan 已提交
185 186
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/excel.png)

P
Pan 已提交
187

花裤衩 已提交
188 189 190 191 192
## [查看更多demo](http://panjiachen.github.io/vue-element-admin)

## License

MIT