pig-ui/README.md

238 lines
7.5 KiB
Markdown
Raw Normal View History

2018-03-04 13:49:35 +08:00
### <font>avue只是刚起步完成了大部分常用的功能更多新颖的功能还在开发中敬请期待......</font>
简体中文
欢迎加入QQ交流群互相学习
一键加群:<a target="_blank" href="https://jq.qq.com/?_wv=1027&k=5zWEvg5"><img border="0" src="//pub.idqqimg.com/wpa/images/group.png"></a><br />
2017-12-14 09:24:24 +08:00
2018-03-04 13:49:35 +08:00
演示地址:[http://122.4.205.228:7777](http://122.4.205.228:7777)<br />
2017-12-14 09:24:24 +08:00
2018-03-04 13:49:35 +08:00
码云地址:[https://gitee.com/smallweigit/avue](https://gitee.com/smallweigit/avue)<br />
2017-12-14 09:24:24 +08:00
2018-03-04 13:49:35 +08:00
github地址[https://github.com/nmxiaowei/avue](https://github.com/nmxiaowei/avue)<br />
## 简介
`avue` 是一个后台集成解决方案支持SSR(服务端渲染)和SPA(单例页面),它基于 [Vue.js](https://github.com/vuejs/vue) 和 [element](https://github.com/ElemeFE/element)。它使用了最新的前端技术栈,权限验证,第三方网站嵌套等功能,很多功能还在开发,敬请期待<br /><br />
`1.vuex本地持久化存储,封装h5的sessionStorage和localStorage`<br /><br />
`2.加入了本地离线的包引入方法去引入vuevue-router等第三方包` [详细介绍](https://my.oschina.net/sunshineS/blog/1583563)<br /><br />
`3.支持SSR服务端渲染(express)`[vue-server-renderer](https://ssr.vuejs.org/zh/)<br /><br />
`4.支持阿里巴巴图标库在线调用,自动同步图标` [阿里巴巴图标库](http://www.iconfont.cn/)<br /><br />
`5.支持iframe嵌套第三方网站`[详细介绍](https://my.oschina.net/sunshineS/blog/1615716)<br /><br />
`6.支持js动态可配CRUD和FORM,节约大量开发成本,配置字典接口自动匹配字典`<br /><br />
`7.支持多种登录方式,本地验证码校验和服务端验证码校验`<br /><br />
`8.全局错误日志记录`<br /><br />
`9.scss模块化开发`<br /><br />
`10.增加系统管理模板(用户管理,角色管理,菜单管理——基于本框架的crud组件自动生成)`<br /><br />
`11.打包后docker一键部署脚本基于nginx镜像具体的可以修改./src/docker/Dockerfile`
**支持路由改变单例页面title**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/title.gif">
</p>
**权限动态切换**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/role.gif">
</p>
**实例**
<p align="center">
<img width="900" src="http://oetrwxnhv.bkt.clouddn.com/form.gif">
</p>
**登录**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-login.png">
</p>
**权限测试页面**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-roles-test.png">
</p>
**错误页面**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-errpage.png">
</p>
**错误日志记录**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-errlog.png">
</p>
**CRUD**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-crud.png">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-grade.png">
</p>
**FORM**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-form.png">
</p>
**用户管理**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-user.png">
</p>
**角色管理**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-role.png">
</p>
**菜单设置**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-menu.png">
</p>
**阿里巴巴图标库(在线调用)**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-ali.png">
</p>
**登录页面SSR渲染**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/login-ssr.png">
</p>
**主页**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-index.png">
</p>
**第三方网站**
<p align="center">
<img width="900" src="https://gitee.com/smallweigit/avue/raw/master/static/cdn/images/avue-iframe.png">
</p>
## 功能
```
- 全局错误日志记录
- vuex持久化存储
- 锁屏
- SSR渲染页面
- 登录/注销
- 用户名登录
- 验证码登录
- 第三方登录(开发中)
- 权限验证
- 第三方网站嵌套
- CRUD(增删改查)
- FORM(动态生成)
- 阿里巴巴图标库(在线调用)
- 系统管理
- 用户管理
- 角色管理
- 菜单管理
- 更多功能开在开发
```
### 按钮的显隐控制
返回的vuex对象中额permission数组包括按钮的权限 例如: ['sys_crud_add', 'sys_crud_export'], crud的增加按钮和导出按钮
### 全局错误日志记录
放开./src/page/errlog/index.vue中的errorA的组件即可测试他是存储在本地可以自己回掉方法上传服务器调用CLEAR_ALL_ERR方法清空本地
### vuex持久化存demo请看
详细demo请看./src/store/modules/tgs.js实例
```bash
...
state:{
...
tag: getStore({ name: 'tag' }) || tagObj
},
...
mutations: {
...
setStore({ name: 'tagList', content: state.tagList, type: 'session' })
...
}
```
### CRUD和FORM使用说明————根据配置json文件自动生成CRUD和FORM并且配置字典接口自动匹配字典
详细demo请看./src/page/table/index.vue和./src/page/form/index.vue实例实例
```bash
子定义操作按钮<br />
<template slot-scope="scope">
<el-button icon="el-icon-check" size="small" @click="handleGrade(scope.row,scope.$index)">权限</el-button>
</template>
js自动配置crud<br />
{
border: true,//表格是否显示边框
index: true,///表格是否显示序号
selection: true,//表格是否显示可选select
dic:['GRADE','SEX'],//传入需要获取字典的变量看vuex中的getDic方法
column: [
{
label: "用户名",//表格的标题
prop: "username",//表格的key
width: "150",//表格的宽度
fixed: true,//是否冻结列
hide:true,//是否隐藏
span:12,//表单格栅显示的列
type:'select', //select | radio | checkbox | date 默认为text
visdiplay:true,//表单不显示
overHidden: true,//超出省略号显示
dicData: 'GRADE', //传入需要引用的字典
],//type的数据字典,当type为select | radio | checkbox 加载
dataDetail: val => {
return `<span class="el-tag">${val}</span>`;;//是否对列表数据处理
},
rules: [{ required: true, message: "请输入用户名", trigger: "blur" }] //表单校验规则
}
}
```
## 开发
```bash
# 克隆项目
git clone https://gitee.com/smallweigit/avue.git
# 安装依赖
npm install
   
# 建议不要用cnpm安装 会有各种诡异的bug 可以通过如下操作解决 npm 下载速度慢的问题
2017-12-14 09:24:24 +08:00
npm install --registry=https://registry.npm.taobao.org
2018-03-04 13:49:35 +08:00
# 启动服务
npm run dev
```
## 调试与发布
```bash
# 构建测试环境
2017-12-14 09:24:24 +08:00
npm run dev
2018-03-04 13:49:35 +08:00
# 构建生成环境
2017-12-14 09:24:24 +08:00
npm run build
2018-03-04 13:49:35 +08:00
# 构建SSR渲染页面
npm run start
```
## 其它
```bash
# 代码检测
npm run lint
# 单元测试
npm run karma
# 构建SSR客户端代码
npm run build:client
# 构建SSR服务端端代码
npm run build:server
```
## License
[MIT](https://gitee.com/smallweigit/avue/blob/master/LICENSE)
Copyright (c) 2017-present Smallwei QQ:1634566606