#morax #api #up #build #toml #morax-api

morax-api

This crate defines public APIs for Morax

1 unstable release

new 0.0.1 Apr 20, 2025

#10 in #morax


Used in morax-client

Apache-2.0

20KB
231 lines

Morax

Discord Apache 2.0 licensed Build Status

Morax is aimed at providing message queue and data streaming functionality based on cloud native services:

  • Meta service is backed by Postgres compatible relational database services (RDS, Aurora, etc.).
  • Data storage is backed by S3 compatible object storage services (S3, MinIO, etc.).

Usage

Currently, Morax supports basic PubSub APIs. You can try it out with the following steps.

  1. Start the environment that provides a Postgres instance and a MinIO instance:

    docker compose -f ./dev/docker-compose.yml up
    
  2. Build the morax binary:

    cargo x build
    
  3. Start the broker:

     ./target/debug/morax start --config-file ./dev/config.toml
    

The broker is now running at localhost:8848. You can talk to it with the morax-client. The wire protocol is HTTP so that all the HTTP ecosystem is ready for use.

You can also get an impression of the interaction by reading the test cases in:

License

This project is licensed under Apache License, Version 2.0.

Dependencies

~4.5MB
~67K SLoC