kju - open communication framework

kju is an open and simple communication framework that works on a request <-> response pattern.

• Any participator can create a request with a number of predefined responses.
• Any participator can redeem a response for a given request

For detailed usage instructions, see the official Documentation

Get started

1. install via npm:

npm i kjujs --save

2. run it with node:

node kju.js
// Running kju server on port 80

This will spin up your kju server

API

Your kju server will offer the following REST Endpints:

• POST /creationToken - Generate a token for creating messages
• POST /message?token=XXX - Create a message
• GET /message/:messageId?token=XXX - Get a raw message
• DELETE /message/:messageId?token=XXX - Delete a message
• GET /messages?token=XXX - Get a list of messages matching a messageTag (encoded inside the token)
• GET /message/:messageId/response/:responseId?token=XXX - Redeem a response
• GET /message/:messageId/responses?token=XXX - Get all responses for a message
• POST /permitCorrespondence?token=XXX - Allow a given sender to send messages

The following two API Endpoints can also be opened int he browser. kju will then render them with a tiny UI.

• /message/:messageId?token=XXX

• /message/:messageId/responses?token=XXX