Bucketeer 服务器- Side SDK 用于节点.js
巴克特尔 是一个开源平台,由 网络代理商 帮助各小组作出更好的决定,减少部署准备时间,并通过特征旗帜释放风险。 Bucketeer提供先进的功能,如暗发射和相继推出,根据用户属性,设备,以及其他部分进行有限的发布.
开始 使用巴克特SDK.
安装
看我们的 文档 安装SDK.
捐款
我们会为你贡献给巴克特 并帮助改善它! 任何人都可以使用和享受它!
请遵照我们的贡献指南 这里。 。 。 .
示例
在树立榜样之前,请遵循以下步骤.
- 确保您拥有
yarn已安装. - 配置
apiEndpoint(与 URL 方案类似)https://)和apiKey信息输入 指数.ts。 。 。 . - 移动到示例目录
cd example。 。 。 . - 安装依赖关系
make init。 。 。 .
构建并启动示例服务器
make start
如果您想要使用已出版的 SDK 而不是本地版本, 请替换其导入库的行 示例代码
发展
设置
安装先决条件工具 .
设置节点版本
请看 .nvmrc (英语) 用于检查节点版本的文件.
nvm use
安装依赖关系
make init
SDK 软件
格式
make fmt
林特类型检查( T)
make lint
make type-check
构建
make build
运行单元测试
make test
运行 e2e 测试
使用环境变量或 a 设置 E2E 测试所需的秘密 .env 文件在工程根中。 需要下列变量,但 SCHEME,这是可选的,默认为 https数字 :
API_ENDPOINT(如api.example.com,无计划)SCHEME(可选;例如https或https,默认为https)CLIENT_API_KEY(客户SDK角色 API 密钥)SERVER_API_KEY(服务员 SDK 角色 API 密钥,用于本地评价测试)
您可以创建 .env 在本地开发的工程根中存档 :
API_ENDPOINT=your.api.endpoint
SCHEME=https
CLIENT_API_KEY=your-client-key
SERVER_API_KEY=your-server-key
E2E测试配置会自动加载这些值.
然后运行 :
make e2e
发布到 npm
将版本字段添加到 软件包.json,然后运行以下命令.
export NPM_TOKEN=<YOUR_NPM_TOKEN>
make publish
写作测试
- 书写测试
src/__tests__目录。 测试文件应当遵循蛇 案例命名惯例. 它与使用骆驼Case的库码不同. - 使用
ava作为测试跑者。 您可以在 ava.config.mjs (英语) 文档. - 使用
make test命令. - 使用
make test-single <path-to-test-file>命令.
说明: 使用 GitHub 动作https://github.com/bucketeer-io/node-server-sdk/blob/master/.github/workflows/release.yml 创建出已发布的标签后发布.