elips

一个企业级全栈应用框架

model 配置

{
	mode: 'dashbord',// 模版类型，不同模版类型对应不一样的模版数据结构
  name: '',// 名称
  desc: '',// 描述
  icon: '',// icon
  homePage: '',// 首页
	// 头部菜单
	menu: [{
		key: '',// 菜单唯一描述
		name: '',// 菜单名称 
		menuTypr: '', //菜单类型：group/module

		// 当 menuType == group 时，可填
		subMenu:[{
			// 可递归 menuItem
		}, ...],

		// 当 menuType === module 时，
		moduleType: '',// 枚举值：sider/iframe/custom/schema

		// moduleType == sider
		siderConfig: {
			menu: [{
				// 可递归 menuItem
			}, ...]
		}

		// moduleType == iframe
		iframeConfig: {
      path: ''// iframe 路径
    },

		// moduleType == custom
		customConfig: {
      path: ''// 自定义路由路径
    },

		// moduleType == schema
		schemaConfig: {
      api: 'api/user'// 数据源 API（遵循 RESTFULL 规范）
      schema: {// 板块数据结构
        type: 'object',
        properties: {
          key: {
            ...schema,// 标准 schema 配置
            type: '',//类型
            label: '',//字段中文名
            // 字段在 table 中的相关配置
            tableOption: {
            	...elTableColunmConfig, // 标准 el-table-column 配置
            	toFixed: 0, // 暴露小数后几位 
            	visiable: true,// 默认为 true (false 时，表示不在 table 中显示)
            },
            // 字段在 searchBar 中的相关配置
            searchOption: {
            	...elComponentConfig, // 标准 el-component 配置
            	comType: '', // 配置组件类型: input/select/date-select/...
            	default: '', // 默认值

            	// comType === 'select'
            	enumList: [], // 下拉框选项

            	// comType === 'dynamic-select'
            	api: ''
            },
            // 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
            // 如： componentConfig.createForm, 这里对应 createFormOption
            // 字段在 createForm 中相关配置
            createFormOption: {
            	...eleComponentConfig,// 标准 el-component 配置
            	comType: '',// 控件类型 input/select/input-number
            	visible: true,// 是否展示(true/false)
            	disabled: false,// 是否禁用（true/false）
            	default: '',// 默认值

            	// comType === 'select' 生效时
            	enumList: [],// 枚举列表
            },
						// 字段在 editForm 表单中的相关配置
						editFormOption: {
							...eleComponentConfig,// 标准 el-component 配置
							comType: '',// 控件类型 input/select/input-number
            	visible: true,// 是否展示(true/false)
            	disabled: false,// 是否禁用（true/false）
            	default: '',// 默认值

            	// comType === 'select' 生效时
            	enumList: [],// 枚举列表
						}
          }，
					detailPanelOption: {
						...eleComponentConfig,// 标准 el-component 配置
					}
          ...
        },
        required: [],// 标记哪些字段是必填项
      },
      // tabel 相关配置
      tableConfig: {
      	headerButtons: [{
      		label: '', // 按钮中文名
      		eventKey: '', // 按钮事件名
      		// 按钮事件具体配置
      		eventOption: {
      			// eventKey === 'showComponent'
      			comName: '',// 组件名称
      		},
      		...elButtonConfig,// 标准的 el-button 配置


      	}, ...],
      	rowButtons: [{
      		label: '', // 按钮中文名
      		eventKey: '', // 按钮事件
      		eventOption: {
      			// eventKey === 'showComponent'
      			comName: '',// 组件名称
      			
      			// 当 event === remove
      			params: {
      				// paramKey = 参数的键值
      				// rowValueKey = 参数值（当格式为 schema::tableKey 的时候，到 table 中找相应的字段）
      				paramKey: rowValueKey,
      			}
      		},// 按钮具体配置
      		...elButtonConfig, // 标准的 el-button 配置
      	}, ...]
      },
      searchConfig: {},// search-bar 相关配置
      // 动态组件相关配置
      componentConfig: {
      	// create-form 表单配置
      	createForm: {
      		title: '',// 表单标题
      		saveBtnText: '',// 保存按钮文案
      	},
				// 编辑 表单配置
				editForm: {
					mainKey: '', // 表单主键， 用于唯一标识要修改的数据对象
      		title: '',// 表单标题
      		saveBtnText: '',// 保存按钮文案
      	}
				// detail-panel 相关配置
				detailPanel: {
					mainKey: '', // 表单主键， 用于唯一标识要修改的数据对象
      		title: '',// 表单标题
				}

      	// 支持用户动态扩展
      },
    }
	}, ...]
}

服务端启动

const {
  serverStart
} = required('@hongdeyuan/elpis');

// 启动 elpis 服务
const app = serverStart({});

自定义服务端

• router-schema
• router
• controller
• service
• extend
• config

前端构建

const { frontendBuild } = required('@hongdeyuan/elpis');

// 编译构建前端工程
frontendBuild(process.env._ENV);

自定义页面扩展

• 在 app/pages 目录下写入口 entry.xxx.js

dashboard / custom-view 自定义页面扩展

• 在 app/pages/dashboard/xxx 下写页面

dashboard / schema-view / components 动态组件扩展

1. 在 app/pages/dashboard/complex-view/schema-view/components 写组件
2. 配置到 app/pages/dashboard/complex-view/schema-view/components/component-config.js

schema-form 控件扩展

1. 在 app/widgets/schema-form/complex-view 下写控件
2. 配置到 app/widgets/schema-form/complex-view/form-item-config.js

schema-search-bar 控件扩展

1. 在 app/widgets/schema-search-bar/complex-view
2. 配置到 app/widgets/schema-search-bar/complex-view/search-item-config.js