elpis

一个企业级应用框架，通过全栈实现

model配置

{
  mode: 'dashboard' // 模板类型，不同模板类型对应不一样的模板数据结构
  name: '' // 名称
  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, // 保留小数位数
              visiable: true, // 默认为 true （false， 表示不在表单中显示）
            },
            // 字段在 search-bar 中的相关配置
            searchOption: {
              ...eleComponentConfig, // 标准 el-component-column 配置
              comType: '', // 配置组件类型 input/select/.....
              default: '', // 默认值

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

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

              // comType === 'select'
              enumList: [], // 下拉选项列表
            },
            editFormOption: {
              ...eleComponentConfig, // 标准 el-component 配置
              comType: '', // 控件类型 input/select/.....
              visible: true, // 是否展示,默认为 true （false， 表示不在表单中显示）
              disabled: false, // 是否禁用, 默认为 false
              default: '', // 默认值

              // comType === 'select'
              enumList: [], // 下拉选项列表
            },
            detailPanelOption: {
              ...eleComponentConfig, // 标准 el-component 配置
            }
          },
          // ...
        },
        required: [] // 必填字段
      },
      // table 相关配置
      tableConfig: {
        headerButtons: [{
          label: '', // 按钮中文名
          eventKey: '', // 按钮事件名
          // 按钮事件具体配置
          eventOption: {
            // 当 eventKey === 'showComponent'
            comName: '', // 组件名称
          }, 
          ...elButtonConfig, // 标准 el-button 配置
        },
        // ...
        ],
        rowButtons: [{
          label: '', // 按钮中文名
          eventKey: '', // 按钮事件名 例如：remove
          eventOption: {
            // 当 eventKey === 'showComponent'
            comName: '', // 组件名称
            // 当 eventKey === 'remove'
            params: {
              // paramKey = 参数的键值
              // rowValueKey = 参数值（当格式为 schema::tableKey 的时候，到 table 中找相应的字段）
              paramKey: rowValueKey // 例如： user_id: schema::user_id
            }
          }, // 按钮事件具体配置
          ...elButtonConfig, // 标准 el-button 配置
        },
        // ... 
      ]
      }, 
      // search-bar 相关配置
      searchConfig: {}, 
      // 动态组件 相关配置
      componentConfig: {
        // create-form 表单相关配置
        createForm: {
          title: '', // 表单标题
          saveBtnText: '', // 保存按钮文本
        },
        editForm: {
          mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
          title: '', // 表单标题
          saveBtnText: '', // 保存按钮文本
        },
        detailPanel: {
          mainKey: '', // 详情面板主键，用于唯一标识要展示的数据对象
          title: '', // 详情面板标题
        }
        // ...支持用户动态扩展
      }
    },
  }]
}

服务端启动

const {
  serverStart
} = require('@talentywh/elpis')

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

自定义服务端

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

前端构建

const { frontendBuild } = require('@talentywh/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/widgets/schema-form/complex-view 下写控件
2. 配置到app/widgets/schema-form/form-item-config.js

schema-search-bar 控件扩展

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