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

      // 当 menuType == sider
      siderConfig: {
        menu: [
          {
            // 可递归 menuItem(除 moduleType == sider)
          },
        ],
      },

      // 当 menuType == iframe
      iframeConfig: {
        path: "",
      },

      // 当 menuType == custom
      customConfig: {
        path: "",
      },

      // 当 menuType == schema
      schemaConfig: {
        api: "/api/user", // 数据源 API 遵循 RESTFUL 规范
        schema: {
          // 板块数据结构
          type: "object",
          properties: {
            // 数据驱动开发 字段配置
            key: {
              ...schema, // 标准 schema 配置
              type: "", // 字段类型
              label: "", // 字段的中文名
              // 字段在 table 中的相关配置
              tableOption: {
                ...elTableColumnConfig, // 标准 el-table-column 配置
                toFixed: 2,
                visible: true, // 自定义字段 默认为 true（false 或 不配置时，表示不在表单中显示）
              },
              // 字段在 search-bar 中的相关配置
              searchOption: {
                ...elComponentItemConfig, // 标准 el-component-column 配置
                comType: "", // 配置组件类型 input/select 等等
                default: "", // 默认值
              },
              // 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
              // 如：componentConfig.createForm, 这里对应 createFormOption
              // 字段在 createForm 中相关配置
              createFormOption: {
                ...elComponentConfig,
                comType: "",
                visible: true,
                disabled: false,
                default: "", // 默认值

                // comType == 'select'
                enumList: [], // 枚举列表
              },
              editFormOption: {
                ...elComponentConfig,
                comType: "",
                visible: true,
                disabled: false,
                default: "", // 默认值

                // comType == 'select'
                enumList: [], // 枚举列表
              },
              // detail
              detailPanelOption: {
                ...elComponentConfig,
              },
            },
          },
          required: [], // 标记哪些字段是必填的
        },
        tableConfig: {
          headerButtons: [
            {
              label: "", // 字段的中文名
              eventKey: "", // 按钮事件名
              eventOption: {
                params: {
                  // 当 eventKey == 'remove'
                  // paramKey = 参数的键值
                  // rowValueKey = 参数值（当格式为 schema::tableKey 的时候，到 table 中找响应的字段）
                  paramKey: rowValueKey,
                },
                // 当 eventKey == 'showComponent
                comName: "", // 组件名称
              }, // 按钮具体配置
              ...elButtonConfig, // 标准 el-button 配置
            },
          ],
          rowButtons: [
            {
              label: "", // 字段的中文名
              eventKey: "", // 按钮事件名
              eventOption: {
                comName: "",
                params: {
                  paramKey: rowValueKey,
                },
              }, // 按钮具体配置
              ...elButtonConfig, // 标准 el-button 配置
            },
          ],
        }, // 表格组件
        searchConfig: {}, // search-bar 配置
        componentConfig: {
          // 整个组件
          // create-form 表单配置
          createForm: {
            title: "", // 表单标题
            saveBtnText: "", // 保存按钮文案
          },
          // edit-form、detail-panel 表单配置
          editForm: {
            mainKey: "",
            title: "", // 表单标题
            saveBtnText: "", // 保存按钮文案
          },
          // ...支持用户动态扩展
        },
        // 模块组件
      },
    },
  ],
};

服务端启动

const { serverStart } = require("@wyj-fe/elpis");

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

自定义服务端

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

前端构建

const { frontendBuild } = require("@wyj-fe/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