@cloudbase/framework-plugin-low-code
TypeScript icon, indicating that this package has built-in type declarations

1.7.33 • Public • Published

Tencent CloudBase Framework Low-Code Plugin

Tencent CloudBase Framework Low-Code Plugin

Github License Npm version issue PRs Welcome star

云开发 CloudBase Framework 框架「低码应用」插件: 通过云开发 CloudBase Framework 框架结合低码平台一键生成并部署微信小程序或 web 应用。

功能特性

使用方法

步骤一. 准备工作

具体步骤请参照 准备云开发环境和 CloudBase CLI 命令工具

步骤二. 进入项目目录进行初始化

如果是目前已有的小程序应用项目

cloudbase

步骤三. 一键部署

cloudbase framework:deploy

配置

需要根据低码平台生成的描述 json 配置 appIdmainAppSerializeDatadependencies,还可配置 buildTypeList 等参数满足特殊需求的场景。

配置示例

cloudbase init 之后会创建云开发的配置文件 cloudbaserc.json,可在配置文件的 plugins 里修改和写入插件配置,其中 inputs 字段为插件输入参数,也可单独创建独立的 input.json 文件声明

{
  "envId": "{{envId}}",
  "framework": {
    "plugins": {
      "client": {
        "use": "@cloudbase/framework-plugin-low-code",
        "inputs": {
          "appId": "appid for low-code app",
          "mainAppSerializeData": {},
          "dependencies": [{}]
        }
      }
    }
  }
}

配置参数说明

appId

必填,低码应用的 appId

mainAppSerializeData

必填,对象,低码应用描述数据

dependencies

必填,对象数组,低码应用组件依赖

buildTypeList

选填,字符串数组,低码应用构建类型,["mp"] 或 ["web"], 代表构建微信小程序或 web 应用,默认微信小程序

mpAppId

当 buildTypeList 为["mp"] 时必填,字符串,需要构建的微信小程序 id

mpDeployPrivateKey

当 buildTypeList 为["mp"] 时必填,字符串,小程序构建私钥,可在微信小程序后台下载,获取内容

deployOptions

当 buildTypeList 为["mp"] 时必填,对象格式

属性名称 类型 是否必填 描述
mode String 小程序构建类型,预览或正式发布 preview 或 upload
version String mode 为 upload 时必填,发布版本号
description String mode 为 upload 时使用,发布说明

更多插件

请访问 CloudBase Framework 插件列表 搭配使用其他插件

文档资料

本地测试

  1. 需要先 link framework。简单可以 clone http://git.code.oa.com/QBase/cloudbase-framework-plugin-low-code.git,切换 release/cals_v2 分支,执行命令,完成 framework-core 的 link;

    yarn
    yarn run bootstrap
    yarn run build
    yarn run link
    
  2. link low-code-plugin。在本目录执行命令,完成 framework 的 link

    yarn
    yarn run build
    yarn run link
    
  3. 本地开发 通过 yarn run dev 监听文件变化并 ts 编译。

  4. __test__/sample 目录中有测试项目,通过添加 .env 文件可指定 mpAppId /ENV_ID 以及 SECRET 等环境变量。input.json 为低码配置,yarn run dev 进行文件生成及发布。

Readme

Keywords

none

Package Sidebar

Install

npm i @cloudbase/framework-plugin-low-code

Weekly Downloads

2

Version

1.7.33

License

Apache-2.0

Unpacked Size

70 kB

Total Files

25

Last publish

Collaborators

  • yuzhen
  • woodenstone
  • justan
  • miusuncle
  • wangjiachen
  • wedabot
  • barretyi
  • daniel-dx
  • issacliu
  • liuyanjie
  • bobbyzhao
  • starkwang
  • yhyang
  • binggg
  • fengkx