Skip to content

ca-dp/bucketeer-web-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DEPRECATED

This repository is no longer maintained. Please update to version V2 following the instructions in the repository below.

https://github.com/bucketeer-io/javascript-client-sdk



Bucketeer Client-side SDK for Web

Setup

Install prerequisite tools.

Setup npm token.

export NPM_TOKEN=<YOUR_NPM_TOKEN>

Install dependencies.

make init

Development

SDK

Format.

make fmt

Lint.

make lint

Build.

make build

Run unit tests.

make test

Run e2e tests. First, replace placeholders in ava-e2e.config.js, then run the command below.

make e2e

Publish to npm. First, add version field to package.json, then run the command below. (Usually you don't need to publish manually because CI/CD workflow publishes automatically.)

make publish

example

Before build example, you need some setups.

  • Build SDK.
  • Replace placeholders in client/index.ts
  • Move to example directory. cd example
  • Install dependencies. make init

Build.

make build

Start example server.

make start

If you want to use published SDK instead of local one, see NOTE: in the example code

Contributing

CONTRIBUTING.md

SDK User Docs

Samples

Bucketeer Samples