relaying-services-sdk v1.0.0
Relaying Services SDK
This repository contains the relaying services SDK providing a way to developers to easy work with the RIF Relay System.
Description
This SDK provides a javascript/typescript library to easily interact with the RIF Relay System.
How to use it
You can use this library once you have it installed on your project. You have a few ways to installing this dependency:
- Use a release version: just install this using the install command for node
npm i --save @rsksmart/relaying-services-sdk
. - Use the distributable directly from the repository: modify your
package.json
file to add this line"@rsksmart/relaying-services-sdk": "https://github.com/JONAF2103/relaying-services-sdk",
Use the development version directly from your changes: clone this repository next to your project and modify your
package.json
file to add this line"@rsksmart/relaying-services-sdk": "../relaying-services-sdk",
After you install the library you can import the RelayingServices interface and the DefaultRelayingServices implementation to start using the SDK.
How to develop
- Clone this repository using
git clone https://github.com/JONAF2103/relaying-services-sdk.git
- Install it using
npm install
- Run
npm run switchPostInstall enable
to enable post install hooks and run againnpm install
- Make your changes and after all the tests and checks are ok you can run
npm run dist
to generate a distributable version - Push your new version into a new branch and create a PR
How to generate a new distributable version
- Bump the version on the
package.json
file. - Commit and push any changes included the bump.
For Github
- Run
npm pack
to generate the tarball to be publish as release on github. - Generate a new release on github and upload the generated tarball.
For NPM
- Run
npm login
to login to your account on npm registry. - Run
npm publish
to generate the distributable version for NodeJS
For direct use
- Run
npm run dist
to generate the distributable version. - Commit and push the dist folder with the updated version to the repository on master.
Husky and linters
We use husky to check linters and code styles on commits, if you commit your changes and the commit fails on lint or prettier checks you can use these command to check and fix the errors before trying to commit again:
npm run lint
: to check linter bugsnpm run lint:fix
: to fix linter bugsnpm run prettier
: to check codestyles errorsnpm run prettier:fix
: to fix codestyles errors
2 years ago