README.md 5.9 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)

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

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

P
Pan 已提交
13
后续会出一系列的教程配套文章,如如何从零构建后台项目框架,如何做完整的用户系统(如权限验证,二次登录等),如何二次开发组件(如富文本),如何整合七牛等等文章,各种后台开发经验等等。莫急~~
P
Pan 已提交
14

P
Pan 已提交
15
相应需求,开了一个qq群 591724180 方便大家交流
P
Pan 已提交
16

P
refine  
Pan 已提交
17
 - [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
P
Pan 已提交
18 19
 - [手摸手,带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2)
 - [手摸手,带你用 vue 撸后台 系列二(登录权限篇)](https://juejin.im/post/591aa14f570c35006961acac)
P
Pan 已提交
20
 - [ 手摸手,带你封装一个vue component](https://segmentfault.com/a/1190000009090836)
P
refine  
Pan 已提交
21

P
Pan 已提交
22 23
 **如有问题请先看上述文章和Wiki,若不能满足,欢迎issue和pr~**
 
P
Pan 已提交
24 25
 **该项目并不是一个脚手架,更倾向于是一个集成解决方案方案**
 
P
Pan 已提交
26 27
 **该项目不支持低版本游览器,有需求请自行添加polyfill[详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**
 
P
refine  
Pan 已提交
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

## 功能
- 登录/注销
- 权限验证
- 侧边栏
- 面包屑
- 富文本编辑器
- Markdown编辑器
- JSON编辑器
- 列表拖拽
- plitPane
- Dropzone
- Sticky
- CountTo
- echarts图表
- 401,401错误页面
- 错误日志
- 导出excel
- table example
P
Pan 已提交
47 48
- 动态table example
- 拖拽table example
P
refine  
Pan 已提交
49 50 51 52
- form example
- 多环境发布
- dashboard
- 二次登录
P
Pan 已提交
53
- 动态侧边栏(支持多级路由)
P
refine  
Pan 已提交
54 55 56 57
- mock数据


## 开发
P
refine  
Pan 已提交
58
```bash
P
Pan 已提交
59
    # 克隆项目
P
refine  
Pan 已提交
60 61
    git clone https://github.com/PanJiaChen/vue-element-admin.git

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

    # 本地开发 开启服务
P
Pan 已提交
68
    npm run dev
P
refine  
Pan 已提交
69
```
P
refine  
Pan 已提交
70 71 72
浏览器访问 http://localhost:9527

## 发布
P
Pan 已提交
73
```bash
P
Pan 已提交
74 75
    # 发布测试环境 带webpack ananalyzer
    npm run build:sit-preview
P
refine  
Pan 已提交
76

P
Pan 已提交
77 78
    # 构建生成环境
    npm run build:prod
P
Pan 已提交
79 80
```

P
refine  
Pan 已提交
81 82 83 84 85
## 目录结构
```shell
├── build                      // 构建相关  
├── config                     // 配置相关
├── src                        // 源代码
P
refine  
Pan 已提交
86
│   ├── api                    // 所有请求
P
refine  
Pan 已提交
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
│   ├── 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 已提交
111 112 113
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).

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


P
Pan 已提交
118
## 效果图
P
update  
Pan 已提交
119

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

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

P
update  
Pan 已提交
124
#### 真正的动态换肤
P
update  
Pan 已提交
125

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


P
Pan 已提交
129

P
update  
Pan 已提交
130
#### 可收起侧边栏
P
update  
Pan 已提交
131

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

P
Pan 已提交
134
#### table拖拽排序
P
update  
Pan 已提交
135

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

P
Pan 已提交
138

P
Pan 已提交
139 140 141 142
#### 动态table

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

P
Pan 已提交
143

P
update  
Pan 已提交
144
#### 上传裁剪头像
P
update  
Pan 已提交
145

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

P
Pan 已提交
148

P
Pan 已提交
149 150
#### 错误统计

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

P
Pan 已提交
153

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

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

P
update  
Pan 已提交
158
#### 封装table组件
P
update  
Pan 已提交
159

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

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

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

P
Pan 已提交
166

P
update  
Pan 已提交
167
#### 导出excel
P
update  
Pan 已提交
168

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

P
Pan 已提交
171 172 173

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