@cary6414/elpis
v1.0.1
Published
Elpis ## 一个企业级应用框架，通过全栈实现
Readme
Elpis
一个企业级应用框架，通过全栈实现
model配置
{
mode: 'dashboard', // 模板类型，不同模板类型对应不一样的模板数据结构
name: '', // 名称
desc: '', // 描述
icon: '', // icon
homePage: '', // 首页（项目配置）
// 头部菜单
menu: [{
key: '', // 菜案唯一描述
name: '', // 菜单名称
menuType: '', // 菜单枚举值: group / module
// 当 menuType == group时，可填
subMenu: [{
// 可递归 menuItem
}, ...],
// 当 menuType == module时，可填
moduleType: '', // 模块枚举值：sider/iframe/custom/schema
// 当moduleType == sider时（侧边栏）
siderConfig: {
menu: [{
// 可递归 menuItem（除 moduleType === sider）
}, ...],
},
// 当moduleType == iframe时，可填
iframeConfig: {
path: '', // iframe路径
},
// 当moduleType == custom时，可填
customConfig: {
path: '', // 自定义路由路径
},
// 当moduleType == schema时，可填
schemaConfig: {
api: '', // 数据源API （遵循 RESTFUL 规范）因为是全栈框架，api都是自己定制的，所以一个api可以表示增删改查
schema: { // 板块数据结构
type: 'object',
properties: {
key: {
...schema, // 标准 schema 配置
type: // 字段类型
label: '', // 字段的中文名
// 字段在 table 中的相关配置
tableOption: {
...elTableColumnConfig, // 标准 el-table-column 配置
visible: true, // 默认为true（false 或不配置时，表示不在表单中显示）
toFixed: 0, //保留小数点后几位
},
// 字段在 search-bar 中的相关配置
searchOption: {
...eleComponentConfig, // 标准 el-component 配置
comType: '', // 配置组件类型 input/select/......
default: '', // 默认值
// comType === 'select'
enumList: [], // 下拉框多选项
// comType === 'dynamicSelect'
api: ''
},
// 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
// 如：componentConfig.createForm, 这里对应 createFormOption
// 字段在 createForm 中相关配置
createFormOption: {
...eleComponentConfig, // 标准 el-component 配置
comType: '', // 控件类型 input/select/input-number
visible: true, // 是否展示（true/false)，默认为 true
disabled: false, // 是否禁用（true/false），默认为 false
default: '', // 默认值
// comType === 'select' 时生效
enumList: [], // 枚举列表
},
// 字段在 edit-form 中相关配置
editFormOption: {
...eleComponentConfig, // 标准 el-component 配置
comType: '', // 控件类型 input/select/input-number
visible: true, // 是否展示（true/false)，默认为 true
disabled: false, // 是否禁用（true/false），默认为 false
default: '', // 默认值
// comType === 'select' 时生效
enumList: [], // 枚举列表
},
// 字段在 detail-panel 中相关配置
detailPanelOption: {
...eleComponentConfig, // 标准 el-component 配置
},
// 后续若要新增功能，先在DSL里定义好
},
...
},
required: [], // 标记哪些字段是必填项
},
// table 相关配置
tableConfig: {
headerButtons: [{
label: '', // 按钮中文名
eventKey: '', // 按钮事件名
eventOption: {
// 当 eventKey === 'showComponent'
comName: '' // 组件名称
}, // 按钮事件具体配置
...elButtonConfig, // 标准的 el-button 配置
},...],
rowButtons: [{
label: '', // 按钮中文名
eventKey: '', // 按钮事件名
eventOption: {
// 当 eventKey === 'showComponent'
comName: '', // 组件名称
// 当 eventKey === 'remove'
params: {
// paramKey = 参数的键值
// rowValueKey = 参数值（当格式为 schema::xxx ，到 table 中找相应的字段）
paramKey: rowValueKey,
}
}, // 按钮事件具体配置
...elButtonConfig, // 标准的 el-button 配置
},...]
},
searchConfig: {}, // search-bar 相关配置
// 动态组件 相关配置
componentConfig: {
// create-form 表单相关配置
createForm: {
title: '', // 表单标题
saveBtnText: '', // 保存按钮文案
},
// edit-form 表单相关配置
editForm: {
mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
title: '', // 表单标题
saveBtnText: '', // 保存按钮文案
}
// ...支持用户动态拓展
},
// detail-panel 相关配置
detailPanel: {
mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
title: '', // 表单标题
}
},
}, ...],
}服务端启动
const { serverStart } = require('@cary6414/elpis');
// 启动 elpis 服务
const app = serverStart({});自定义服务端
- router-schema
- router
- controller
- service
- extend
- config
前端构建
const { frontendBuild } = require('@cary6414/elpis');
// 编译构建前端工程
frontendBuild(process.env._ENV);webpack config扩展
- 配置在 app/webpack.config.js
自定义页面扩展
- 在 app/pages/ 目录下写入口 entry.xxx.js
dashboard / custom-view 自定义页面扩展
- 在 app/pages/dashboard/xxx 下写页面
dashboard / schema-view / component 动态组件扩展
在 app/pages/dashboard/complex-view/schema-view/components/ 下写组件
配置到 app/pages/dashboard/complex-view/schema-view/components/components-config.js
schema-form 控件扩展
- 在 app/pages/widgets/schema-form/complex-view/ 下写控件
- 配置到 app/pages/widgets/schema-form/form-item-config.js
schema-search-bar 控件扩展
- 在 app/pages/widgets/schema-search-bar/complex-view/ 下写控件
- 配置到 app/pages/widgets/schema-search-bar/search-item-config.js