admin-fe/README.md

165 lines
6.5 KiB
Markdown
Raw Normal View History

2017-11-21 08:10:22 +00:00
<p align="center">
2017-11-21 08:15:34 +00:00
<img width="320" src="https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg">
2017-11-21 08:10:22 +00:00
</p>
2017-11-29 02:33:39 +00:00
# vue-element-admin
2017-07-31 06:45:32 +00:00
2017-11-29 02:33:39 +00:00
[![vue](https://img.shields.io/badge/vue-2.5.9-brightgreen.svg)](https://github.com/vuejs/vue)
2017-11-30 10:17:54 +00:00
[![element-ui](https://img.shields.io/badge/element--ui-2.0.7-brightgreen.svg)](https://github.com/ElemeFE/element)
2017-07-31 06:45:32 +00:00
[![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)]()
2017-11-29 03:21:48 +00:00
**A magical vue admin.**
2017-07-31 06:45:32 +00:00
2017-11-29 02:33:39 +00:00
- [线上地址](http://panjiachen.github.io/vue-element-admin)
2017-04-25 05:53:49 +00:00
2017-11-29 03:21:48 +00:00
- [使用文档](https://panjiachen.github.io/vue-element-admin-site/#/)
2017-05-12 05:56:22 +00:00
2017-11-29 02:33:39 +00:00
- [English Document](https://github.com/PanJiaChen/vue-element-admin/blob/master/README-en.md)
2017-05-16 03:08:17 +00:00
2017-11-29 02:33:39 +00:00
- [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
- [donate](https://panjiachen.github.io/vue-element-admin-site/#/donate)
2017-07-19 08:23:40 +00:00
2017-09-11 02:56:28 +00:00
**本项目的定位是后台集成方案,不适合当基础模板来开发。**
- 模板建议使用: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)  
- 桌面端: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
2017-07-19 08:23:40 +00:00
2017-07-04 07:52:12 +00:00
2017-11-29 02:33:39 +00:00
**注意该项目目前使用element-ui@2.0.5版本,所以最低兼容 Vue 2.5.0**
2017-05-16 05:39:11 +00:00
2017-11-14 06:37:12 +00:00
楼主这里有一份调查[问卷](https://www.wjx.cn/m/16866569.aspx) 有空请填写一下,以表对本项目的支持~ps:不是给这个调查问卷网站做广告,所以填完问卷不用点上面抽奖有的没的那些东西
2017-11-01 02:05:31 +00:00
2017-11-29 02:33:39 +00:00
## 前序准备
2017-07-07 03:12:49 +00:00
2017-11-29 02:33:39 +00:00
你的本地环境需要安装 [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),提前了解和学习这些知识会对使用本项目有很大的帮助。
2017-04-25 06:29:48 +00:00
2017-11-29 02:33:39 +00:00
同时配套一个系列的教程文章,如何从零构建后一个完整的后台项目,建议大家先看完这些文章再来实践本项目
2017-05-22 05:46:11 +00:00
- [手摸手,带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2)
- [手摸手,带你用 vue 撸后台 系列二(登录权限篇)](https://juejin.im/post/591aa14f570c35006961acac)
2017-06-13 05:44:01 +00:00
- [手摸手,带你用 vue 撸后台 系列三 (实战篇)](https://juejin.im/post/593121aa0ce4630057f70d35)
2017-07-04 08:17:39 +00:00
- [手摸手带你用vue撸后台 系列四(vueAdmin 一个极简的后台基础模板)](https://juejin.im/post/595b4d776fb9a06bbe7dba56)
2017-06-13 05:44:01 +00:00
- [手摸手带你封装一个vue component](https://segmentfault.com/a/1190000009090836)
2017-05-16 03:08:17 +00:00
2017-07-07 03:12:49 +00:00
相应需求开了一个qq群 `591724180` 方便大家交流
2017-09-11 02:56:28 +00:00
2017-09-08 12:10:54 +00:00
或者可以加入该 **[圈子](https://jianshiapp.com/circles/1209)** 讨论问题
2017-06-14 10:02:12 +00:00
2017-11-29 03:21:48 +00:00
**如有问题请先看上述使用文档和文章,若不能满足,欢迎 issue 和 pr**
2017-06-14 10:02:12 +00:00
2017-11-29 02:33:39 +00:00
**本项目并不是一个脚手架,更倾向于是一个集成解决方案**
2017-06-14 10:02:12 +00:00
2017-09-11 02:56:28 +00:00
**该项目不支持低版本游览器(如ie)有需求请自行添加polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**
2017-06-14 10:02:12 +00:00
2017-04-25 05:53:49 +00:00
## 功能
- 登录/注销
- 权限验证
2017-11-29 02:33:39 +00:00
- 多环境发布
- 动态侧边栏(支持多级路由)
- 动态面包屑
- 国际化多语言
- 多种动态换肤
- 快捷导航(标签页)
2017-04-25 05:53:49 +00:00
- 富文本编辑器
- Markdown编辑器
- JSON编辑器
2017-11-29 02:33:39 +00:00
- Screenfull全屏
2017-04-25 05:53:49 +00:00
- 列表拖拽
2017-11-29 02:33:39 +00:00
- Svg Sprite 图标
- Dashboard
- 本地mock数据
- Echarts 图表
- Clipboard(剪贴复制)
- 401/404错误页面
2017-04-25 05:53:49 +00:00
- 错误日志
- 导出excel
2017-11-29 02:33:39 +00:00
- 导出zip
2017-09-11 06:43:12 +00:00
- 前端可视化excel
2017-11-29 02:33:39 +00:00
- Table example
2017-05-09 07:16:20 +00:00
- 动态table example
- 拖拽table example
2017-06-14 10:02:12 +00:00
- 内联编辑table example
2017-11-29 02:33:39 +00:00
- Form example
- 二步登录
- SplitPane
- Dropzone
- Sticky
- CountTo
- Markdown2html
2017-04-25 05:53:49 +00:00
## 开发
2017-04-24 09:04:40 +00:00
```bash
2017-04-24 10:31:47 +00:00
# 克隆项目
2017-04-25 05:53:49 +00:00
git clone https://github.com/PanJiaChen/vue-element-admin.git
2017-04-24 10:31:47 +00:00
# 安装依赖
npm install
2017-11-29 03:21:48 +00:00
   
//or # 建议不要用cnpm  安装有各种诡异的bug 可以通过如下操作解决npm速度慢的问题
2017-04-28 09:43:50 +00:00
npm install --registry=https://registry.npm.taobao.org
2017-04-25 05:53:49 +00:00
# 本地开发 开启服务
2017-04-25 09:10:18 +00:00
npm run dev
2017-04-24 09:04:40 +00:00
```
2017-04-25 05:53:49 +00:00
浏览器访问 http://localhost:9527
## 发布
2017-04-24 10:19:35 +00:00
```bash
2017-04-24 10:31:47 +00:00
# 发布测试环境 带webpack ananalyzer
npm run build:sit-preview
2017-04-25 05:53:49 +00:00
2017-04-24 10:31:47 +00:00
# 构建生成环境
npm run build:prod
2017-04-24 10:19:35 +00:00
```
2017-11-29 03:21:48 +00:00
更多信息请参考 [使用文档](https://panjiachen.github.io/vue-element-admin-site/#/)
2017-04-25 05:53:49 +00:00
## 目录结构
```shell
├── build // 构建相关  
├── config // 配置相关
├── src // 源代码
2017-05-02 05:05:00 +00:00
│   ├── api // 所有请求
2017-04-25 05:53:49 +00:00
│   ├── assets // 主题 字体等静态资源
│   ├── components // 全局公用组件
│   ├── directive // 全局指令
2017-11-29 02:33:39 +00:00
│   ├── filtres // 全局 filter
│   ├── icons // 项目所有 svg icons
│   ├── lang // 国际化 language
│   ├── mock // 项目mock 模拟数据
2017-04-25 05:53:49 +00:00
│   ├── router // 路由
2017-11-29 02:33:39 +00:00
│   ├── store // 全局 store管理
2017-04-25 05:53:49 +00:00
│   ├── styles // 全局样式
│   ├── utils // 全局公用方法
2017-11-29 02:33:39 +00:00
│   ├── vendor // 公用vendor
│   ├── views // view
2017-04-25 05:53:49 +00:00
│   ├── App.vue // 入口页面
2017-11-29 02:33:39 +00:00
│   ├── main.js // 入口 加载组件 初始化等
│ └── permission.js // 权限管理
2017-04-25 05:53:49 +00:00
├── static // 第三方不打包资源
│   └── Tinymce // 富文本
├── .babelrc // babel-loader 配置
├── eslintrc.js // eslint 配置项
├── .gitignore // git 忽略项
├── favicon.ico // favicon图标
├── index.html // html模板
└── package.json // package.json
```
2017-05-31 10:28:06 +00:00
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).
2017-07-19 08:23:40 +00:00
## [查看更多demo](http://panjiachen.github.io/vue-element-admin)
2017-11-29 02:33:39 +00:00
![](https://wpimg.wallstcn.com/1bc334a6-32a8-4f29-a037-ac3f5ce32588.png)
## Donate
If you find this project useful, you can buy me a cup of coffee
![donate](https://panjiachen.github.io/donate/donation.png)
2017-07-19 08:23:40 +00:00
## License
MIT