elpis

一个企业级全栈应用框架

model配置

{
  mode: "dashboard", //模版类型，不同模版类型对应不一样的模版数据结构
  name: "123",
  desc: "",
  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规范）
        schema: {
          // 板块数据结构
          type: "object",
          properties: {
            [key]: {
              ...schema, // 标准 schema配置
              type: "", // 字段类型
              label: "", //字段中文名
              // 字段在table中的相关配置
              tableOption: {
                ...elTableColumnConfig, //标准 el-table-column配置
                toFixed: 0, //保留小数点后几位
                visible: true //默认为true（false时，表示不在表单中显示）
              },
              // 字段在search-bar中的相关配置
              searchOption: {
                ...elComponentConfig, //标准 el-component-column配置
                comType: "", //配置组件类型 input/select/....
                default: "", //默认值

                // 当comType==='select'
                enumList: [
                  //下拉框可选项
                  {
                    label: "",
                    value: ""
                  }
                ],
                // 当comType==='dynamicSelect'
                api: ""
              },
              // 字段在不同动态 component 中的相关配置，前缀对应 componentConfig中的键值
              // 如： componentConfig.createForm,这里对应createFormOption
              // 字段在createForm中的相关配置
              createFormOption: {
                ...eleComponentConfig, // 标准 el-component 配置
                comType: "", // 控件类型 input/select/date-range...
                visible: true, // 是否展示
                disabled: false, // 是否禁用
                default: "", // 默认值

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

                // comType === 'select'时生效
                enumList: [] // 枚举列表
              },
              detailPanelOption: {
                ...eleComponentConfig // 标准 el-component 配置
              }
            },
            required: [] // 标记哪些字段是必填项
          }
        },
        // table相关配置
        tableConfig: {
          headerButtons: [
            {
              label: "", //按钮中文名
              eventKey: "", // 按钮事件名
              //按钮事件具体配置
              eventOption: {
                // 当eventKey === 'showComponent'
                comName: "" // 组件名称
              },
              ...eventButtonConfig //标准el-button配置
            }
          ],
          rowButtons: [
            {
              label: "", //按钮中文名
              eventKey: "", // 按钮事件名
              //按钮事件具体配置
              eventOption: {
                // 当eventKey === 'showComponent'
                comName: "", // 组件名称
                // 比如：当eventKey ==='remove'
                params: {
                  // paramKey = 参数的键值
                  // rowValueKey = 参数值，格式为 schema::tableKey,到table中找相应的字段
                  paramKey: rowValueKey
                }
              },
              ...eventButtonConfig //标准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("@coder-scy/elpis");

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

自定义服务端

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

前端构建

const { frontendBuild } = require("@coder-scy/elpis");

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

自定义页面扩展

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

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

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

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/pages/widgets/schema-form/complex-view 下写控件
2. 配置到 app/pages/widgets/schema-form/form-item-config.js

schema-search-bar 控件扩展

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