/eventcatalog

An open source documentation tool to bring discoverability to your event-driven architectures

Primary LanguageTypeScriptMIT LicenseMIT

πŸ“– EventCatalog

MIT License PRs Welcome blog

header

Features: Documentation generator for Event Driven Architectures, Markdown driven, Document Domains/Services/Messages/Schemas and more, Content versioning, Assign Owners, Schemas, OpenAPI, MDX Components and more...

All Contributors

Read the Docs | Edit 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)
  • ⭐ 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:

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 will let you generate documentation from your systems.

You can read more on how it works on the website

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.

Sponsors

Thank you to our project sponsors.


hookdeck

Serverless infrastructure for event-driven architecture.

Learn more

Sponsors help make EventCatalog sustainable, want to help the project? Get in touch! Or visit our sponsor page.

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?

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 npm run i
  3. Run the command npm 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
David Boyne

πŸ’» πŸ–‹ 🎨 πŸ’‘ πŸ€” πŸ“–
Benjamin Otto
Benjamin Otto

πŸ’» πŸ€” πŸ“– πŸ›
Tiago Oliveira
Tiago Oliveira

πŸ“– πŸ›
Jay McGuinness
Jay McGuinness

πŸ“–
David Khourshid
David Khourshid

πŸ“–
thim81
thim81

πŸ€” πŸ› πŸ’»
Muthu
Muthu

πŸ›
Dan Tavelli
Dan Tavelli

πŸ“–
steppi91
steppi91

πŸ“–
Donald Pipowitch
Donald Pipowitch

πŸ› πŸ’»
Ken
Ken

πŸ“–
Rodolfo Toro
Rodolfo Toro

πŸ’»
Drew Marsh
Drew Marsh

πŸ’»
Dec Kolakowski
Dec Kolakowski

πŸ’» πŸ“–
Yevhenii Dytyniuk
Yevhenii Dytyniuk

πŸ’»
lcsbltm
lcsbltm

πŸ’»
Matt Martz
Matt Martz

πŸ’»
Michel Grootjans
Michel Grootjans

πŸ’»
Arturo Abruzzini
Arturo Abruzzini

πŸ’»
Ad L'Ecluse
Ad L'Ecluse

πŸ’»
Rafael Renan Pacheco
Rafael Renan Pacheco

πŸ’» πŸ“–
Luis Diego
Luis Diego

πŸ’»
Daniel Ruf
Daniel Ruf

πŸ“–
Fredrik Johansson
Fredrik Johansson

πŸ’»
Naresh Kumar Reddy Gaddam
Naresh Kumar Reddy Gaddam

πŸ’»
Andre Deutmeyer
Andre Deutmeyer

πŸ’»
Pebbz
Pebbz

πŸ’»
Alexander Holbreich
Alexander Holbreich

πŸ“–
JosΓ© Delgado
JosΓ© Delgado

πŸ’»
jlee-spt
jlee-spt

πŸ’»
Kim RejstrΓΆm
Kim RejstrΓΆm

πŸ’»
Christophe Gabard
Christophe Gabard

πŸ’»
Carlo Bertini
Carlo Bertini

πŸ’»
David Regla
David Regla

πŸ’»
Marcio Vinicius
Marcio Vinicius

πŸ’»
Daniel Andres Castillo Ardila
Daniel Andres Castillo Ardila

πŸ’»
Baerten Dennis
Baerten Dennis

πŸ’»
Ryan Cormack
Ryan Cormack

πŸ’»
Nathan Birrell
Nathan Birrell

πŸ’»
Jack Tomlinson
Jack Tomlinson

πŸ’»
Carlos Rodrigues
Carlos Rodrigues

πŸ’»
omid eidivandi
omid eidivandi

πŸ’»
Simone Fumagalli
Simone Fumagalli

πŸ“–
d-o-h
d-o-h

πŸ’»

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

License

MIT.