项目名称:小鱼易连小程序 SDK
项目介绍
小鱼易连小程序 SDK 项目,提供基础的 SDK 组件/方法,以及对应的 Demo 项目;
环境要求
- 最新开发者工具;
- 一个支持推拉流权限的小程序账号:appid;
- 最新 Node 版本,建议 v12+;
前提条件
获取项目
拉取SDK仓库;
安装依赖
如果需要使用内部 Npm 资源,建议通过 Nrm 切换镜像到 XYLink 上。
$ yarn
获取启动参数
- 获取 Token,参见文档;
- 将获取到的 Token 在
xylinkSDK/tools/demo/config.js
中配置;
注意:此准备工作使用 Auto 布局模式入会,如需要使用 Custom 自定义模式,需要在
xylinkSDK/tools/demo/config.js
文件中配置 Template 模版数据;
开发调试
启动调试
建议在调试模式之前,先清理文件
# 清理
$ yarn clean
$ yarn clean-dev
开始构建资源
# 构建一次源码/Demo项目
$ yarn dev
# 监听变动构建源码/Demo项目
$ yarn watch
本地运行
- 执行完成启动/构建命令之后,会在根目录生成
miniprogram_dev
文件,此文件是可运行小程序程序的项目,通过小程序开发者工具打开; - 在开发者工具中配置使用 npm 模块,执行:工具->构建 npm;
- 执行编译并预览;
集成文档
小鱼小程序 SDK 集成文档;
目录结构
├── LICENSE
├── README.md
├── gulpfile.js
├── miniprogram_dev // 小程序运行目录,通过执行构建自动生成
├── package.json // 依赖文件
├── src // 组件和方法库源文件
│ ├── common
│ ├── index.js
│ ├── index.json
│ ├── index.wxml
│ └── index.wxss
├── test // 测试文件
├── tools // 工具函数文件、示例程序目录
│ ├── build.js
│ ├── checkcomponents.js
│ ├── config.js // 配置文件
│ ├── demo // 示例程序目录
│ ├── test // 测试文件
│ └── utils.js
└── yarn.lock
版本说明
备注
- 在执行发版本时,如果修改了
tools/demo/pages/common
目录下的任何文件,需要手动将此文件 merge 到src/common
目录下,保证版本的正确性;