README.md

Relay Hub

Reference implementation of a Relay protocol hub

See overview for in-depth documentation on how the hub works

Installation

Prerequisites

All infrastructure components required to run the service and tests are available via docker, these must be up and running before starting the service or running the tests:

docker compose up

Testing

Run the tests via:

yarn test

Running the service

Before starting the service, make sure to have the required environment variables configured (check the .env.example file for all required and optional configuration variables).

Start the service via:

yarn start