0.3.0 • Published 4 months ago
@bucketeer/node-server-sdk v0.3.0
Bucketeer Server-Side SDK for Node.js
Table of Contents
Installation
The Bucketeer server-side SDK for Node.js is available on npm as @bucketeer/node-server-sdk
:
$ npm install --save @bucketeer/node-server-sdk
Example
Before building an example, you need some setups.
- Replace placeholders in index.ts
- Move to example directory.
cd example
- Install dependencies.
make init
Build and start example server.
make start
If you want to use published SDK instead of local one, see NOTE:
in the example code
Documentation
Contributing
Development
Setup
Install prerequisite tools.
Setup node version.
nvm use
Setup npm token.
export NPM_TOKEN=<YOUR_NPM_TOKEN>
Install dependencies.
make init
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