Elpis

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

package.json

"scripts": {
    "lint": "eslint --quiet --ext js,vue .",
    "test": "cross-env _ENV=local mocha 'test/**/*.js'",
    "dev": "cross-env _ENV=local nodemon ./index.js",
    "beta": "cross-env _ENV=beta nodemon ./index.js",
    "prod": "cross-env _ENV=prod nodemon ./index.js",
    "build:dev": "node --max_old_space_size=4096 ./app/webpack/dev.js",
    "build:prod": "node ./app/webpack/prod.js"
  }

关于vscode用到的插件

ESLint、BMC-tpl、Prettier格式化工具、Chinese(简体中文)、HTML Boilerplate、HTML/CSS/JavaScript Snippets 、Markdown All in One、Qii Theme、TypeScript Vue Plugin (Volar)、Vue (Official)、Vuter、tpl Lang

项目说明

======================

用提交代码正确规范--需要可在package.json配置
"config": {
      "ghooks": {
        "commit-msg": "validate-commit-msg",
        "pre-commit": "npm run lint"
      }
    }

middleware、controller文件for循环解释说明

/**
  [a,b,c,...,customModule(目录),customMiddleware(文件)]

  第一次
  tempMiddleware[a] = {}
  tempMiddleware = tempMiddleware[a]

  第二次
  tempMiddleware[b] = {}
  tempMiddleware = tempMiddleware[b]

  第三次
  tempMiddleware[c] = {}
  tempMiddleware = tempMiddleware[c]

  middleware.a.b.c.customModule.customMiddleware //使得目录达到这种效果


 */

for(let i = 0,len = name.length;i < len; ++i){
      console.log('--------for循环----',i,name[i],name);
      if(i === len-1){ //如果循环到最后一位则是文件
        tempMiddleware[name[i]] = require(path.resolve(file))(app);
      }else{  //否则是文件夹
        if(!tempMiddleware[name[i]]){
          tempMiddleware[name[i]] = {};
        }
        tempMiddleware = tempMiddleware[name[i]];
      }
    }

nodemon--代码改动会自动识别进行重新加载编译

model配置

{
  mode: 'dashboard', //模板类型,不同模板类型对应不一样的模板数据结构
  names: '', //名称
  desc: '', //描述
  icon: '', //图标
  homePage: '', //首页(项目配置)
  //头部菜单
  menu: [{
    key: '', //菜单唯一
    name: '', //菜单名称
    menuType: '', //枚举值,group / module

    //当 menuType === group时，可填
    subMenu: [{
      //可递归 menuType
    },...],

    //当 menuType === module 时，可填
    moduleType: '', //枚举值: sider/iframe/custom/schema

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

    //当 menuType === iframe 时
    iframeConfig: {
      path: '', //iframe路径
    },

    //当 menuType === custom 时
    customConfig: {
      path: '', //自定义路径
    },

    //当 menuType === schema 时
    schemaConfig: {
      api: '/api/user', //数据源API (遵循 RESTFUL 规范)
        schema: { //板块数据结构
          type: 'object',
          properties: {
            key: {
              ...schema, //标准 schema 配置
              type: '', //字段类型
              lable: '', //字段的中文名
              //字段table中的相关配置
              tableOption: {
                ...elTableColumnConfig, //标准el-table-column配置
                toFixed: 0, //保留小数点后几位
                visible: true,  //默认true,false时,表示不在表单中显示
              },
              //字段在 search-bar中的相关配置
              searchOption: {
                ...eleComponentConfig, //标准el-component-column配置
                comType: '', //配置组件类型 input/select/...
                default: '', //默认值

                //comType === 'select'
                enumList: [], //下拉框可选项

                //comType === 'dynamicSelect'
                api: ''
              },
              /**
               * 字段在不同 component中的相关配置,前缀对应componentCofig中的键值
               * 如: componentConfig.createForm,这里对应createFormOption
               * 字段在createForm中相关配置
               */
              createFormOption: {
                ...elTableColumnConfig, //标准el-table-column配置
                comType: '', //控件类型 input/select
                visible: true, //是否展示 (true/false) 默认为true
                disabled: false, //是否禁用 (true/false) 默认为false
                default: '', //默认值

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

                //comType === 'select' 时生效
                enumList: [] //枚举列表
              },
              detailPanelOption: {
                ...elTableColumnConfig //标准el-table-column配置
              }
            }
          },
          required: [], //标记哪些字段是必填项
        },
        tableConfig: {
          headerButtons: [{
            lable: '', //按钮中文名
            eventKey: '', //按钮事件名
            eventOption: {
              //当 eventKey === 'showComponent'
              comName: '' //组件名称
            }, //按钮事件具体配置
            ...elButtinConfig //标准el-button配置
          },...],
          rowButtons: [{
            lable: '', //按钮中文名
            eventKey: '', //按钮事件名
            eventOption: {
              //当 eventKey === 'showComponent'
              comName: '', //组件名称
              //当 eventKey === 'remove'
              params: {
                //paramKey = 参数的键值
                paramKey: rowValueKey  //rowValueKey =参数值 (当格式为schema：tableKey的时候,到table中找相应的字段)
              }
            }, //按钮事件具体配置
            ...elButtinConfig //标准el-button配置
          },...]
        }, //table 相关配置
        searchConfig: {}, //search-bar 相关配置
        //动态组件 相关配置
        componentConfig: {
          //create-form 表单相关配置
          createForm: {
            title: '', //表单标题
            saveBtnText: '', //保存按钮文案
          },
          //edit-form 表单相关配置
          editForm: {
            mainKey: '', //表单主键,用于唯一标识要修改的数据对象
            title: '', //表单标题
            saveBtnText: '', //保存按钮文案
          },
          //detail-panel相关配置
          detailPanel: {
            mainKey: '', //表单主键,用于唯一标识要修改的数据对象
            title: '', //表单标题
          },
          // ...支持用户动态扩展
        } //模块组件
    }
  },...]
}

服务端启动

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

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

自定义服务端

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

前端构建

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