开发文档

# fxext

fxext 是酷狗直播小程序的命令行开发工具，用于执行项目创建、开发、打包等任务。

# 安装

要求 node 版本为12.x及以上，npm >= 6.0。

提示：为了保证您的安装速度，可以先切换为淘宝源后，再执行后续指令。

npm config set registry https://registry.npm.taobao.org

# 全局安装脚手架
npm i -g @fxext/cli

project-name为您的项目名

# 创建

fxext init project-name

项目初始化时，需要进行如下4步交互操作：

  1. 输入小程序appId：appId，前往开发者中心中，小程序 “概要” 信息中获取。确保appId准确，才能生成正确调试二维码进行APP端调试
  2. 选择小程序模式：目前支持选择 “主播模式” 和 “用户模式”，需与在开发者中心中，创建小程序时选择的保持一致
  3. 选择项目使用框架

fxext-init

# 开发

# 1. 启动本地开发服务

npm run start

# 2. 程序配置

启动本地服务后，会在命令行控制台输出如下信息：

  1. 本地开发的 IP 地址和端口号
  2. 客户端调试二维码，请确保项目初始化时输入appId和小程序模式正确，若有错误，请在项目初始化后的project.config.json中进行修改
  3. 本地服务地址信息

build-result

开发版下的小程序的页面访问地址由本地开发服务所提供，需要开发者在开发者中心中按提示手动填写本地开发的 IP 地址和端口号并提交，平台会根据填写的配置信息来下发对应的页面 URL 到直播间的小程序中。

set-app

如修改 project.config.json 引起开发配置变化，需要再次到开发者中心修改开发配置。

# 打包

npm run release

打包项目资源用于上传，打包后的资源将置于项目根目录的 release 目录中（可配置）。

fxext-release

需要把该目录下的压缩包上传至开发者中心。 upload

注：在开发版中未审核通过前，始终访问到的开发配置中配置的地址，而不是上传的终端代码；在审核通过或者正式版中，访问到的是终端代码中的程序。

npm 包

package.json 中声明的依赖包必须都为公网 npm 包，不能包含私有 npm 包，否则将导致小程序构建失败。

# 配置

我们在project.config.json中可以看到项目的配置信息，如下图所示
project.config

# 升级小程序前端sdk版本

修改project.config.json下的builder.sdkVersion字段后重新运行项目

← 基本流程 →