node-server-sdk's Introduction

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 the token 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.

nvm
Yarn

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 Actions https://github.com/bucketeer-io/node-server-sdk/blob/master/.github/workflows/release.yml to publish it when the released tag is created.

node-server-sdk's People

Contributors

Stargazers

Watchers

node-server-sdk's Issues

Use REST instead of GRPC

upgrade eslint to use flat config

Publish npm package fails in workflow

npm notice Publishing to https://registry.npmjs.org/
npm ERR! code E404
npm ERR! 404 Not Found - PUT https://registry.npmjs.org/@bucketeer%2fnode-server-sdk - Not found
npm ERR! 404 
npm ERR! 404  '@bucketeer/[email protected]' is not in this registry.
npm ERR! 404 
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.

npm ERR! A complete log of this run can be found in:
npm ERR!     /home/runner/.npm/_logs/2024-01-25T03_17_39_627Z-debug-0.log
Error: Process completed with exit code 1.