Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Prerequisites

  • Rust toolchain ≥ 1.85 (edition 2024) — install via rustup
  • SQLite (system library, used by sqlx)
  • OpenSSL or native-tls (used by reqwest / tokio-tungstenite)

On macOS:

brew install openssl sqlite

On Ubuntu/Debian:

apt install libssl-dev libsqlite3-dev pkg-config

Build

git clone https://github.com/amjadjibon/mercury
cd mercury
cargo build --workspace --release

Dev tools

The following tools are used for documentation and benchmarking. Install them once:

cargo install mdbook           # build this book
cargo install cargo-criterion  # benchmark runner

Verify

cargo test --workspace

All tests should pass with no warnings.