Skip to content

About

The Reckon Codex - No Nonsense Event Sourcing. Mirror of codeberg.org/reckon-db-org/reckon-codex.

Resources

Security policy

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

The Reckon Codex

No Nonsense Event Sourcing.

The opinionated book that ships with the reckon stack: reckon-db, evoq, reckon-gateway, reckon-proto, reckon-go, reckon-dotnet.

Reading

The book is published as a PDF on the releases page and as a browsable HTML site (link to follow). The PDF is the canonical form.

Status

Scaffolding stage. Chapter 2 (the D5 model) is the gold-standard reference for the rest. Other chapters are present as stubs and will be filled in subsequent revisions; each stub names what the chapter will cover so the spine is visible even before the prose is.

Part Chapter Status
Front Preface, How to read this book ✅ drafted
I 1. Why event sourcing ✅ first cut
I 2. The D5 model ✅ first cut
I 3. Pizza Architecture ✅ first cut
I 4. Names that scream ✅ first cut
I 5. Dossiers and Decisions ✅ first cut
I 6. Pipelines and Process Managers ✅ first cut
I 7. The Reckon Cycle ✅ first cut
II 8. reckon-db ✅ first cut
II 9. evoq ✅ first cut
II 10. reckon-gateway and reckon-proto ✅ first cut
II 11. Worked example: a lending library ✅ first cut
III 12. Antipatterns ✅ first cut
III 13. Glossary ✅ first cut
Appendix Reckon and the Critter Stack ✅ first cut
Back Colophon ✅ drafted

Building locally

The book is built with Quarto.

# Install Quarto (see https://quarto.org/docs/get-started/)
quarto --version

# Render to PDF + HTML (output in _book/)
quarto render

# Or just PDF
quarto render --to pdf

PDF rendering requires a TeX distribution. The first run installs the necessary packages via tinytex:

quarto install tinytex

Building in CI

Every push to main triggers .github/workflows/build.yml. The workflow:

  1. Sets up Quarto and tinytex.
  2. Renders to PDF + HTML.
  3. Uploads the PDF as an artifact.
  4. On tag push (v*), creates a release and attaches the PDF.

Contributing

Errata, structural feedback, prose corrections welcome via issues or pull requests. The book is intended to evolve with the stack; substantive content changes ship as numbered revisions.

Licence

See LICENSE for the top-level summary.

Related

About

The Reckon Codex - No Nonsense Event Sourcing. Mirror of codeberg.org/reckon-db-org/reckon-codex.

Resources

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages