EventCatalog is a documentation tool for software architectures —
bring discoverability to complex systems.

Install

The recommended way to install the latest version of EventCatalog is by running the command below:

npx @eventcatalog/create-eventcatalog@latest my-catalog

Looking for help? Start with our Getting Started guide

Documentation

Visit our official documentation.

Support

Having trouble? Get help in the official EventCatalog Discord.

Demos

Here are some examples of EventCatalog in action:

• Finance System
• Healthcare System
• E-Commerce System
• SaaS System

Contributing

If you have any questions, features or issues please raise any issue or pull requests you like. We will try my best to get back to you.

You can find the contributing guidelines here.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

David Boyne 💻 🖋 🎨 💡 🤔 📖	Benjamin Otto 💻 🤔 📖 🐛	Tiago Oliveira 📖 🐛	Jay McGuinness 📖	David Khourshid 📖	thim81 🤔 🐛 💻	Muthu 🐛
Dan Tavelli 📖	steppi91 📖	Donald Pipowitch 🐛 💻	Ken 📖	Rodolfo Toro 💻	Drew Marsh 💻	Dec Kolakowski 💻 📖
Yevhenii Dytyniuk 💻	lcsbltm 💻	Matt Martz 💻	Michel Grootjans 💻	Arturo Abruzzini 💻	Ad L'Ecluse 💻	Rafael Renan Pacheco 💻 📖
Luis Diego 💻	Daniel Ruf 📖	Fredrik Johansson 💻	Naresh Kumar Reddy Gaddam 💻	Andre Deutmeyer 💻	Pebbz 💻	Alexander Holbreich 📖
José Delgado 💻	jlee-spt 💻	Kim Rejström 💻	Christophe Gabard 💻	Carlo Bertini 💻	David Regla 💻	Marcio Vinicius 💻
Daniel Andres Castillo Ardila 💻	Baerten Dennis 💻	Ryan Cormack 💻	Nathan Birrell 💻	Jack Tomlinson 💻	Carlos Rodrigues 💻	omid eidivandi 💻
Simone Fumagalli 📖	d-o-h 💻	Cristian Pallarés 💻	Sebastian Rendon 💻	Craig Roberts 💻	Ivan Milosavljevic 📖	Martin Meredith 💻
Ruud Welling 💻	Kevin Pouget 💻	Vitalii Balash 💻	Arnaud Babilone 💻	Alexander Horner 💻	simonwfarrow 💻	Augusto Romero Arango 💻
cc-stjm 💻	Lucian Lature 🐛 💻	Vilas Chauvhan 💻	Eric Hoffman 🐛	wimhaesen-kine 💻	Ondrej Musil 🐛 🤔	Anatoly Bolshakov 💻
reisingerf 📖	Jonathan Barette 💻	mumundum 💻	Piotr Rybarczyk 🐛	ZakaryaCH 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

License

EventCatalog is source-available under the Business Source License 1.1. It is free for eligible organisations (under USD 10M revenue and under USD 10M funding). Otherwise it is covered by a subscription. See pricing.

@eventcatalog/core version 5.0.0 (including its pre-releases) and later is covered by that licence. Releases up to and including 4.x remain available under the MIT License (see NOTICE).