Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.67 KB

README.md

File metadata and controls

58 lines (38 loc) · 1.67 KB
Raw

RMB Direct Client

Version Lint Build

This is a Typescript client that can be used to build both services, and clients that can talk over the rmb.

RMB is a message bus that enable secure and reliable RPC calls across the globe.

This client can do the following:

  • send requests over the distributed rmb-relay.
  • receive and verify responses to sent requests.

An example of this client usage is defined under examples.

Built with

  • Typescript

Getting Started

To get a local copy up and running following these simple steps:

  • Open Terminal
  • Change the current working directory to the location you want the cloned directory.
  • Enter the following:
git clone https://github.com/threefoldtech/tfgrid-sdk-ts.git

  • Press Enter to create your local clone.

  • Navigate to the cloned repository by running:

cd tfgrid-sdk-ts/packages/rmb_direct_client
  • Then run the following to start the client:
yarn install
yarn workspace @threefold/rmb_direct_client start

Prerequisites

  • Node.js
  • Git
  • Yarn

To update the RMB Messages to a newer version refer to DEVELOPER.README.md file.