Potamic

Potamic is a message queue implementation over Redis' Stream data type. It makes it simple to read and write as multiple consumers, automatically tracking "read", "pending" and "processed" messages.

Index

1. Get Potamic
2. Quickstart
3. Docs
4. Running Locally
5. License

Get Potamic

deps.edn

TODO: Publish to Clojars

Leiningen

TODO: Publish to Clojars

Quickstart

TODO: add quickstart

Docs

Online

https://chadangelelli.github.io/potamic

Local

git clone https://github.com/chadangelelli/potamic.git

cd potamic

open docs/index.html

Running Locally

Testing

You'll need 2 terminals open; 1 for Redis and 1 for the test runner.

Redis:

cd /path/to/potamic

bin/db

Test Runner:

cd /path/to/potamic

bin/test
# or
bin/test --watch

REPL

cd /path/to/potamic

bin/repl

Generating Docs

cd /path/to/potamic

bin/doc

License

Distributed under the EPL v1.0 (same as Clojure).

Copyright © 2023 Chad Angelelli