Skip to content

Commit 39d2606

Browse files
committed
doc:update readme
1 parent d68d464 commit 39d2606

File tree

2 files changed

+52
-105
lines changed

2 files changed

+52
-105
lines changed

README.md

Lines changed: 51 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,39 @@
22
<img width="320" src="https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg">
33
</p>
44

5-
# vue-element-admin
5+
# vue-element-admin
66

7-
[![vue](https://img.shields.io/badge/vue-2.4.2-brightgreen.svg)](https://github.com/vuejs/vue)
8-
[![element-ui](https://img.shields.io/badge/element--ui-1.4.2-brightgreen.svg)](https://github.com/ElemeFE/element)
7+
[![vue](https://img.shields.io/badge/vue-2.5.9-brightgreen.svg)](https://github.com/vuejs/vue)
8+
[![element-ui](https://img.shields.io/badge/element--ui-2.0.5-brightgreen.svg)](https://github.com/ElemeFE/element)
99
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)
1010
[![GitHub release](https://img.shields.io/github/release/PanJiaChen/vue-element-admin.svg)]()
1111

12+
A magical vue admin.
1213

13-
[线上地址](http://panjiachen.github.io/vue-element-admin)
14+
- [线上地址](http://panjiachen.github.io/vue-element-admin)
1415

15-
[English Document](https://github.com/PanJiaChen/vue-element-admin/blob/master/README-en.md)
16+
- [文档地址](https://panjiachen.github.io/vue-element-admin-site/#/)
1617

17-
[wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
18+
- [English Document](https://github.com/PanJiaChen/vue-element-admin/blob/master/README-en.md)
1819

19-
[donate](https://github.com/PanJiaChen/vue-element-admin#donate)
20+
- [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
21+
22+
- [donate](https://panjiachen.github.io/vue-element-admin-site/#/donate)
2023

2124
**本项目的定位是后台集成方案,不适合当基础模板来开发。**
2225
- 模板建议使用: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)  
2326
- 桌面端: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
2427

2528

26-
27-
**注意:该项目目前使用[email protected]版本,所以最低兼容 Vue 2.3.0**
29+
**注意:该项目目前使用[email protected]版本,所以最低兼容 Vue 2.5.0**
2830

2931
楼主这里有一份调查[问卷](https://www.wjx.cn/m/16866569.aspx) 有空请填写一下,以表对本项目的支持~ps:不是给这个调查问卷网站做广告,所以填完问卷不用点上面抽奖有的没的那些东西
3032

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

35+
你的本地环境需要安装 [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),提前了解和学习这些知识会对使用本项目有很大的帮助。
3436

35-
写了一个系列的教程配套文章,如何从零构建后一个完整的后台项目:
36-
37-
- [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
37+
同时配套一个系列的教程文章,如何从零构建后一个完整的后台项目,建议大家先看完这些文章再来实践本项目
3838
- [手摸手,带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2)
3939
- [手摸手,带你用 vue 撸后台 系列二(登录权限篇)](https://juejin.im/post/591aa14f570c35006961acac)
4040
- [手摸手,带你用 vue 撸后台 系列三 (实战篇)](https://juejin.im/post/593121aa0ce4630057f70d35)
@@ -47,45 +47,46 @@
4747

4848
**如有问题请先看上述文章和Wiki,若不能满足,欢迎 issue 和 pr**
4949

50-
**该项目并不是一个脚手架,更倾向于是一个集成解决方案**
50+
**本项目并不是一个脚手架,更倾向于是一个集成解决方案**
5151

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

5454

5555
## 功能
5656
- 登录/注销
5757
- 权限验证
58-
- 侧边栏
59-
- 面包屑
58+
- 多环境发布
59+
- 动态侧边栏(支持多级路由)
60+
- 动态面包屑
61+
- 国际化多语言
62+
- 多种动态换肤
63+
- 快捷导航(标签页)
6064
- 富文本编辑器
6165
- Markdown编辑器
6266
- JSON编辑器
67+
- Screenfull全屏
6368
- 列表拖拽
64-
- plitPane
65-
- Dropzone
66-
- Sticky
67-
- CountTo
68-
- echarts图表
69-
- 401404错误页面
69+
- Svg Sprite 图标
70+
- Dashboard
71+
- 本地mock数据
72+
- Echarts 图表
73+
- Clipboard(剪贴复制)
74+
- 401/404错误页面
7075
- 错误日志
7176
- 导出excel
72-
- zip
77+
- 导出zip
7378
- 前端可视化excel
74-
- table example
79+
- Table example
7580
- 动态table example
7681
- 拖拽table example
7782
- 内联编辑table example
78-
- form example
79-
- 多环境发布
80-
- dashboard
81-
- 二次登录
82-
- 动态侧边栏(支持多级路由)
83-
- mock数据
84-
- cache tabs example
85-
- screenfull
86-
- markdown2html
87-
- views-tab
88-
- clipboard
83+
- Form example
84+
- 二步登录
85+
- SplitPane
86+
- Dropzone
87+
- Sticky
88+
- CountTo
89+
- Markdown2html
8990

9091

9192
## 开发
@@ -121,15 +122,19 @@
121122
│   ├── assets // 主题 字体等静态资源
122123
│   ├── components // 全局公用组件
123124
│   ├── directive // 全局指令
124-
│   ├── filtres // 全局filter
125-
│   ├── mock // mock数据
125+
│   ├── filtres // 全局 filter
126+
│   ├── icons // 项目所有 svg icons
127+
│   ├── lang // 国际化 language
128+
│   ├── mock // 项目mock 模拟数据
126129
│   ├── router // 路由
127-
│   ├── store // 全局store管理
130+
│   ├── store // 全局 store管理
128131
│   ├── styles // 全局样式
129132
│   ├── utils // 全局公用方法
130-
│   ├── view // view
133+
│   ├── vendor // 公用vendor
134+
│   ├── views // view
131135
│   ├── App.vue // 入口页面
132-
│   └── main.js // 入口 加载组件 初始化等
136+
│   ├── main.js // 入口 加载组件 初始化等
137+
│ └── permission.js // 权限管理
133138
├── static // 第三方不打包资源
134139
│   └── Tinymce // 富文本
135140
├── .babelrc // babel-loader 配置
@@ -144,73 +149,15 @@
144149
## Changelog
145150
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).
146151

147-
## Donate
148-
If you find this project useful, you can buy me a cup of coffee
149-
![donate](https://panjiachen.github.io/donate/donation.png)
150-
151152
## 状态管理
152153
后台只有user和app配置相关状态使用vuex存在全局,其它数据都由每个业务页面自己管理。
153154

154-
155-
## 效果图
156-
157-
#### 两步验证登录 支持微信和qq
158-
159-
![两步验证 here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/2login.gif)
160-
161-
#### 真正的动态换肤
162-
163-
![真正的动态换肤](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/theme.gif)<br />
164-
165-
#### tabs
166-
167-
![tabs](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/tabs.gif)<br />
168-
169-
170-
171-
#### 可收起侧边栏
172-
173-
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/leftmenu.gif)
174-
175-
#### table拖拽排序
176-
177-
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/order.gif)
178-
179-
180-
#### 动态table
181-
182-
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/dynamictable.gif)
183-
184-
185-
#### 上传裁剪头像
186-
187-
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/uploadAvatar.gif)
188-
189-
190-
#### 错误统计
191-
192-
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/errorlog.gif)
193-
194-
195-
#### 富文本(整合七牛 打水印等个性化功能)
196-
197-
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/editor.gif)
198-
199-
#### 封装table组件
200-
201-
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/table.gif)
202-
203-
#### 图表
204-
205-
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/echarts.gif)
206-
207-
208-
#### 导出excel
209-
210-
![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/excel.png)
211-
212-
213155
## [查看更多demo](http://panjiachen.github.io/vue-element-admin)
156+
![](https://wpimg.wallstcn.com/1bc334a6-32a8-4f29-a037-ac3f5ce32588.png)
157+
158+
## Donate
159+
If you find this project useful, you can buy me a cup of coffee
160+
![donate](https://panjiachen.github.io/donate/donation.png)
214161

215162
## License
216163

build/utils.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ exports.cssLoaders = function (options) {
2323
var postcssLoader = {
2424
loader: 'postcss-loader',
2525
options: {
26-
sourceMap: options.sourceMap
26+
sourceMap: true
2727
}
2828
}
2929

0 commit comments

Comments
 (0)