This is a Message-Oriented Middleware (MOM) for server-side apps to communicate over Awala without implementing any of the networking or cryptography from the protocol suite.
In concrete terms, as an Awala Internet Endpoint, this middleware implements the Awala protocol PoHTTP as a server and a client, thus acting as a bridge between the app and its users' Awala gateways.
Documentation for operators and app developers is available on docs.relaycorp.tech.
This app requires the following system dependencies:
- Node.js 18.
- Kubernetes 1.22+ (we strongly recommend Minikube with Docker).
- Knative v1.9+.
- Skaffold v2.1+.
To start the app, simply get Skaffold to deploy the relevant Kubernetes resources by running npm start.
The unit test suite can be run with the standard npm test.
If you'd like to run some tests against the real instance of the app managed by Skaffold, the simplest way to do that is to add/modify functional tests and then run npm run test:integration (alternatively, you can use your IDE to only run the test you're interested in).
If for whatever reason you want to manually test the app, you first need to get the local URLs to the services by running:
kn service list
We love contributions! If you haven't contributed to a Relaycorp project before, please take a minute to read our guidelines first.