📖 EventCatalog

The open source tool to help you discover and document your event-driven architectures

Features: Documentation for Event Driven Architectures, Integration with any broker, Generator from your OpenAPI and AsyncAPI documents, Docs and Code, Markdown driven, Document Domains/Services/Messages/Schemas and more, Content versioning, Assign Owners, Schemas, OpenAPI, MDX Components and more...

Read the Docs | View Demo

---

Core Features

• 📃 Document domains, services and messages (demo)
• 📊 Visualise your architecture (demo)
• ⭐ Supports any Schema format (e.g Avro, JSON) (demo)
• 🗂️ Document any code examples (Any code snippet)
• 💅 Custom MDX components (read more)
• 🗄️ Version domains, services and messages
• ⭐ Discoverability feature (search, filter and more) (demo)
• ⭐ Document teams and users (demo)
• 🤖 Automate your catalogs with generators (e.g generate your catalogs from your AsyncAPI/OpenAPI documents)
• 👨🏼‍💻 Follows Docs as code principles
• ⭐ And much more...

The problem

Event-driven architectures are becoming more popular, giving us the ability to write decoupled architectures and use messages as away to communicate between domains/teams.

When starting with event-driven architectures you may have a handful of services and messages. As this scales with your team and organization it becomes very hard to manage and govern this.

Over a period of time more events are added to our domain, requirements change, and our architecture scales.

As more domains, services or messages get added to our architecture they can be hard for teams to discover and explore.

Many teams ignore documentation and governance and end up in a sea of complexity (watch the talk here) .

EventCatalog was built to help document your event-driven architectures and help your teams explore and understand events, schemas and much more.

Read more on these blogposts and videos:

• Introducing EventCatalog v2 (2024)
• Introducing EventCatalog v1 (2022)
• Event-Driven Architecture: Beyond the Schema Registry (blog)
• Complexity is the Gotcha of Event-driven Architecture (VIDEO) by David Boyne

This solution

Think of EventCatalog as a website generator that allows you to document your event architectures powered by markdown.

EventCatalog is focused on discovery and documentation and allows you to:

• Document Domains/Services/Messages/Schemas/Code Examples and more...
• Visually shows relationships between upstream/downstream services using your Events
• Allows you to version your documentation and supports changelogs
• Add owners to domains,services and messages so your teams know who owns which parts of your domain
• And much more...

EventCatalog is technology agnostic, which means you can integrate your Catalog with any EDA technology of your choice and any schema formats.

EventCatalog supports a Plugin Architecture which lets you generate documentation from your systems including OpenAPI, AsyncAPI, Event Brokers and more.

You can read more on how it works on GitHub

Getting Started

You should be able to get setup within minutes if you head over to our documentation to get started 👇

➡️ Get Started

Or run this command to build a new catalog

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

Demo

Here is an example of a Retail system using domains, services and messages.

demo.eventcatalog.dev

You can see the markdown files that generated the website in the GitHub repo under examples.

Enterprise support

Interested in collaborating with us? Our offerings include dedicated support, priority assistance, feature development, custom integrations, and more.

Find more details on our services page.

Looking for v1?

• Documentation: https://v1.eventcatalog.dev
• Code: https://github.com/event-catalog/eventcatalog/tree/v1

Still using v1 of EventCatalog? We recommnded upgrading to the latest version. Read more in the migration guide.

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.

Running the project locally

1. Clone the repo
2. Install required dependencies pnpm install
3. Run the command pnpm run start:catalog

• This will start the catalog found in /examples repo, locally on your machine

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 🐛

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

License

MIT.