@bucketeer/node-server-sdk
v0.3.3
Published
[![npm version](https://badge.fury.io/js/@bucketeer%2Fnode-server-sdk.svg)](https://badge.fury.io/js/@bucketeer%2Fnode-server-sdk)
Downloads
181
Readme
Bucketeer Server-Side SDK for Node.js
Bucketeer is an open-source platform created by CyberAgent to help teams make better decisions, reduce deployment lead time and release risk through feature flags. Bucketeer offers advanced features like dark launches and staged rollouts that perform limited releases based on user attributes, devices, and other segments.
Getting started using Bucketeer SDK.
Installation
See our documentation to install the SDK.
Contributing
We would ❤️ for you to contribute to Bucketeer and help improve it! Anyone can use and enjoy it!
Please follow our contribution guide here.
Example
Before building the example, please follow the following steps.
- Ensure that you have the
yarn
installed. - Configure the
host
and thetoken
info in the index.ts. - Move to the example directory
cd example
. - Install dependencies
make init
.
Build and start an example server
make start
If you want to use a published SDK instead of a local one, replace the line where it imports the library in the example code
Development
Setup
Install the prerequisite tools.
Setup node version
Please look at the .nvmrc file to check the node version.
nvm use
Install dependencies
make init
SDK
Format
make fmt
Lint
make lint
Build
make build
Run unit tests
make test
Run e2e tests
Configure the host
and the token
info in the ava-e2e.config.mjs, then run the following command.
make e2e
Publish to npm
Add the version field to package.json, then run the following command.
export NPM_TOKEN=<YOUR_NPM_TOKEN>
make publish
Note: The publishing process is automated using GitHub Actionshttps://github.com/bucketeer-io/node-server-sdk/blob/master/.github/workflows/release.yml to publish it when the released tag is created.