README.md

Event sauce

The event sourcing paradigm for Rust

• event-sauce - the main event sourcing crate
• event-sauce-derive - derives for easier implementation
• event-sauce-storage-sqlx - sqlx storage backend interface for event-sauce.

Build environment

1. Install rustup
2. Install rustfmt with rustup component add rustfmt
3. Install the nightly toolchain with rustup toolchain add nightly
4. Install cargo-readme
5. Install linkchecker with pip install linkchecker

To run integration tests, Postgres must be running:

docker-compose up -d

You can connect to it at postgres://sauce:sauce@localhost:5432/sauce

To emulate a full CI build, run:

./build.sh

Other useful commands:

• cargo build - build the crate
• cargo doc - generate documentation
• cargo test --lib or cargo test --doc - run lib or doc tests respectively, does not require Postgres server
• cargo test -- --test-threads=1 - run all tests (requires local Postgres server to be running). test-threads=1 is required to prevent database race conditions.