SPV Channels client API is a client library for SPV Channels API that can be used inside nodejs environment or inside web browser.
SPV Channels client API requires NodeJS that can be downloaded from https://nodejs.org/
-
Open the terminal
-
Navigate to folder containing SPV Channels client API
-
Install dependencies using npm
npm install -
Run build
npm run buildThis will build client library into
buildfolder and can be used for local develompent where you list client API as dependency via package.json. -
Pack libraries into single .js file using webpack
npm run distThis will pack client API and all of its dependencies into a single file inside
distfolder. -
Build and run node examples
npm run build-examplesTo run node.js example run:
npm run example-node [serviceUrl] [accountId] [username] [password]To run web example use:
npm run example-weband open http://localhost:8080 in your browser.
-
Build documentation
npm run docThis will create documentation into
docfolder. Open doc/index.html in browser to view documentation.