The purpose of this service is to be your real-time BaaS (Backend as a Service).
Broker is a SSE message broker that requires you write no backend code to have a full real-time API.
Broker is born from the need that rather than building a complex REST API with web-sockets and a SQL database to provide reactive web forms (like for React) there must be a simpler way.
Broker follows an insert-only/publish/subscribe paradigm rather than a REST CRUD paradigm.
In Broker you create a user, login, then insert an event with its data. Broker then publishes the event via SSE.
When the client first subscribes to the SSE connection all the latest events and data is sent to the client. Combined with sending the latest event via SSE when subscribed negates the necessity to do any GET API requests in the lifecycle of an event.
The side-effect of this system is that the latest event is the schema. This is pure NoSQL as the backend is agnostic to the event data.
Firebase is not open-source, is not free, and has complicated pricing. Parse Server doesn't have real-time features and is about 30,000 LOC of JS.
Yes with React Native. There may be native 3rd party libraries for SSE that work. In the future official libraries may be made available for native platforms.
html
POST /users
- public endpoint
- POST JSON to create a user
json
{"username":{...}, "password":{...}}
- where {...} is for username is a string and password is a string
will return 200 or 500 or 400
html
POST /login
- public endpoint
- POST JSON to login
json
{"username":{...}, "password":{...}}
- where {...} is for username is a string and password is a string
will return
json
{"jwt":{...}}
- where {...} is a JWT (string)
html
GET /sse
- authenticated endpoint (Authorization: Bearer {jwt})
- connect your sse-client to this endpoint using broker-client
- note: broker-client uses fetch as eventsource doesn't support headers
html
POST /insert
- authenticated endpoint (Authorization: Bearer {jwt})
- POST JSON to insert an event
json
{"event":{...}, "data":{...}}
- where {...} is for the event a string and data is any JSON you want
will return: 200 or 500 or 400 or 401
cargo install broker
./broker --db="tmp" --port="443" --secure="true" --origin="*" --jwt_expiry="86400" --jwt_secret="secret" --key_path="broker.rsa" --cert_path="broker.pem"