elpis

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

model配置

module.exports = {
  mode: 'dashboard', // 模板类型，不同模板类型对应不一样的模板数据结构
  name: '', // 模板名称
  desc: '', // 模板描述
  icon: '', // 模板图标
  homePage: '', // 模板首页
  // 头部菜单
  menu: [
    {
      key: '', // 菜单唯一标识
      name: '', // 菜单名称
      menuType: '', // 菜单类型，1：一级菜单 module，2：二级菜单 group
      // 当 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 配置
              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: [], // 下拉框可选项

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

                // 当 comType === 'select' 时
                enumList: [], // 枚举列表 下拉框可选项
              },
              // 字段在 editForm 中相关配置
              editFormOption:{
                ...elComponentConfig, // 标准 el-component 配置
                comType:'', // 控件类型 input/select/input-number
                visible:true, // 是否展示（true/false）,默认为 true
                disabled: false, // 是否禁用（true/false）,默认为 false
                default:'', // 默认值
                // 当 comType === 'select' 时
                enumList: [], // 枚举列表 下拉框可选项
              },
              // 字段在 detailPanel 中相关配置
              detailPanelOption:{
                ...elComponentConfig // 标准 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
              }
            }, // 按钮事件具体配置
            ...elButtonConfig // 标准 el-button 配置
          }]
        },
        // search-bar 搜索配置
        searchConfig:{}, 
        // 动态组件 相关配置
        componentConfig:{
          // create-form 表单相关配置
          createForm:{
            title:'', // 表单标题
            saveBtnText:'', // 保存按钮文字
          },
          // ...支持用户动态扩展
          // edit-form 表单相关配置
          editForm:{
            mainKey:'', // 表单主键，用于唯一标识要修改的对象
            title:'', // 表单标题
            saveBtnText:'', // 保存按钮文案
          },
          // detail-panel 相关配置
          detailPanel:{
            mainKey:'', //表单主键，用于唯一标识要查看的对象
            title:'', // 表单标题
          }
        }
      }
    },
    // 可递归 menuItem
    {}
  ]
};

服务端启动

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

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

自定义服务端

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

前端构建

const { frontendBuild } = require('@d2xu/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