#elpis

一个企业级全栈应用框架

model配置

{
  // 模板 -> 模型(dsl) -> 项目 -> 应用/系统
  mode: 'deshboard', // 模板类型，不同模板类型对应不同的数据结构
  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/user', // 数据源API （遵循restful规范）
        // 板块数据结构
        schema: {
          type: 'object',
          properties: {
            key: {
              ...schema, // 标准 schema 配置
              label: '', // 字段中文名
              type: '', // 字段类型
              // 字段在 table 中的相关配置
              tableOption: {
                ...elTableColumnConfig, // 标准el-table-column 配置
                toFixed: 0, // 保留小数点后几位
                visible: true // 默认为true( false时，表示不在表单中显示)
              },
              searchOption: {
                ...elCompontConfig, // 标准的element-component-column 配置
                comType: 'input/select', // 配置组件类型 input/select/....
                default: '', // 默认值

                // comType: 'select'
                enumList: [], // 下拉框可选项
                // comType: 'dynamicSelect'
                api: '' // dynamicSelect option 请求地址
              },
              // 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
              // 如：component.createForm 这里对应createFormOption
              // 字段在 createForm 中的相关配置
              createFormOption: {
                ...elCompontConfig, // 标准的element-component 配置
                comType: '', // 控件类型 input/select/input-number
                visible: true, // 是否展示（true/false），默认为true
                disable: false, // 是否禁用(true/false)，默认为false
                default: '', // 默认值
                // comType === 'select' 生效
                enumList: [] // 枚举列表
              },
              // 字段在editForm表单中的相关配置
              editFormOption: {
                ...elCompontConfig, // 标准的element-component 配置
                comType: '', // 控件类型 input/select/input-number
                visible: true, // 是否展示（true/false），默认为true
                disable: false, // 是否禁用(true/false)，默认为false
                default: '', // 默认值
                // comType === 'select' 生效
                enumList: [] // 枚举列表
              },
              detailPanelOption: {
                ...elCompontConfig // 标准的element-component 配置
              }
            }
          },
          required: [] // 标记哪些字段是必填项
        },
        // table 相关配置
        tableConfig: {
          headerButtons: [
            {
              label: '', // 按钮中文名
              eventKey: '', // 按钮事件名
              // 按钮具体配置
              eventOption: {
                // 当eventKey === 'showCompontent'
                conName: '' // 组件名称
              },
              ...elButtionConfig // 标准的el-button 配置
            }
          ],
          rowButtons: [
            {
              label: '', // 按钮中文名
              eventKey: '', // 按钮事件名
              eventOption: {
                // 当eventKey === 'showCompontent'
                conName: '', // 组件名称
                // 当 eventKey = 'remove'
                params: {
                  // paramKey = 参数的键值
                  // rowValueKey = 参数值（当格式为 schema::tableKey 的时候，到table 中找到响应字段）
                  paramKey: rowValueKey
                }
              }, // 按钮具体配置
              ...elButtionConfig // 标准的el-button 配置
            }
          ]
        },
        searchConfig: {}, // search-bar 相关配置
        // 动态组件 相关配置
        compomentConfig: {
          createForm: {
            title: '', // 表单标题
            saveBtnText: '' // 保存按钮文案
          },
          // edit-form 表单相关配置
          editForm: {
            mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
            title: '', // 表单标题
            saveBtnText: '' // 保存按钮文案
          },
          // detail-panel 相关配置
          detailPanel: {
            mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
            title: '' // 表单标题
          }
          // 支持用户动态扩展
        }
      }
    }
  ]
}

服务端启动

const { serverStart } = require('@h-jia_l/elpis')
// 启动 elpis 服务
const app = serverStart({})

自定义服务端

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

前端构建

const { frontendBuild } = require('@h-jia_l/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/compiex-view/schema-view/components 下写组件
2. 配置到 app/pages/dashboard/compiex-view/schema-view/components/component-config.js

schema-form 控件扩展

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

schema-search-bar 控件扩展

1. 在 app/pages/widgets/schema-search-bar/comfiex-view 下写组件
2. 配置到 app/pages/widgets/schema-search-bar/search-item-config.js