Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/event-catalog/eventcatalog

An open source documentation tool to bring discoverability to your event-driven architectures
https://github.com/event-catalog/eventcatalog

architecture catalog ddd documentation eda event-driven events plugins

Last synced: 3 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/event-catalog/eventcatalog
Owner: event-catalog
License: mit
Created: 2021-11-18T20:59:21.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-12-05T15:46:42.000Z (8 days ago)
Last Synced: 2024-12-06T05:12:00.353Z (7 days ago)
Topics: architecture, catalog, ddd, documentation, eda, event-driven, events, plugins
Language: TypeScript
Homepage: https://eventcatalog.dev
Size: 18.2 MB
Stars: 1,816
Watchers: 21
Forks: 152
Open Issues: 73
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

awesome-ccamel - event-catalog/eventcatalog - An open source documentation tool to bring discoverability to your event-driven architectures (TypeScript)
awesome-github-repos - event-catalog/eventcatalog - An open source documentation tool to bring discoverability to your event-driven architectures (TypeScript)

README

        


📖 EventCatalog


[![MIT License][license-badge]][license]

[![PRs Welcome][prs-badge]][prs]



[![](https://dcbadge.limes.pink/api/server/https://discord.gg/3rjaZMmrAm?style=flat)](https://discord.gg/3rjaZMmrAm) [](https://www.linkedin.com/in/david-boyne/) [![blog](https://img.shields.io/badge/blog-EDA--Visuals-brightgreen)](https://eda-visuals.boyney.io/?utm_source=event-catalog-gihub) 



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](https://img.shields.io/badge/all_contributors-46-orange.svg?style=flat-square)](#contributors-)

[Read the Docs](https://eventcatalog.dev/) | [Edit the Docs](https://github.com/event-catalog/docs) | [View Demo](https://demo.eventcatalog.dev/docs)





# Core Features

- 📃 Document domains, services and messages ([demo](https://demo.eventcatalog.dev/docs))

- 📊 Visualise your architecture ([demo](https://demo.eventcatalog.dev/visualiser))

- ⭐ Supports any Schema format (e.g Avro, JSON) ([demo](https://demo.eventcatalog.dev/docs/events/InventoryAdjusted/0.0.4))

- 🗂️ Document any code examples (Any code snippet)

- 💅 Custom MDX components ([read more](https://eventcatalog.dev/docs/development/components/using-components))

- 🗄️ Version domains, services and messages

- ⭐ Discoverability feature (search, filter and more) ([demo](https://demo.eventcatalog.dev/discover/events))

- ⭐ Document teams and users ([demo](https://demo.eventcatalog.dev/docs/teams/full-stack))

- 🤖 Automate your catalogs with [generators](https://www.eventcatalog.dev/docs/development/plugins/plugin-overview) (e.g generate your catalogs from your [AsyncAPI](https://www.eventcatalog.dev/docs/ascynapi)/[OpenAPI](https://www.eventcatalog.dev/docs/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)](https://www.youtube.com/watch?v=VLUvfIm9wnQ&t=1s) .

**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)](https://eventcatalog.dev/blog/eventcatalog-v2)

- [Introducing EventCatalog v1 (2022)](https://www.boyney.io/blog/2022-01-11-introducing-eventcatalog)

- [Event-Driven Architecture: Beyond the Schema Registry (blog)](https://www.boyney.io/blog/2021-12-05-documenting-events)

- [Complexity is the Gotcha of Event-driven Architecture (VIDEO) by David Boyne](https://www.youtube.com/watch?v=VLUvfIm9wnQ&t=1s)

# 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](https://eventcatalog-website-v2.vercel.app/docs/development/plugins/plugin-overview) which will let you generate documentation from your systems.

You can read more on [how it works on the website](https://eventcatalog.dev)

# Getting Started

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

➡️ [Get Started](https://eventcatalog-website-v2.vercel.app/docs/development/getting-started/installation)

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](https://demo.eventcatalog.dev)

You can see the markdown files that generated the website in the GitHub repo under [examples](/examples).

# Sponsors

Thank you to our project  sponsors.

## Gold sponsors





  

  Manage, secure, and govern every API in your organization

  Learn more







  

  Delivering Apache Kafka professional services to your business



  Learn more





_Sponsors help make EventCatalog sustainable, want to help the project? Get in touch! Or [visit our sponsor page](https://www.eventcatalog.dev/support)._

# 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](https://eventcatalog.dev/services).

# 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](https://eventcatalog.dev/docs/development/guides/upgrading-from-version-1)._

# 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](https://eventcatalog.dev/docs/contributing/overview).

## Running the project locally

1. Clone the repo

1. Install required dependencies `npm run i`

1. Run the command `npm run start:catalog`

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

[license-badge]: https://img.shields.io/github/license/event-catalog/eventcatalog.svg?color=yellow

[license]: https://github.com/event-catalog/eventcatalog/blob/main/LICENSE

[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square

[prs]: http://makeapullrequest.com

[github-watch-badge]: https://img.shields.io/github/watchers/event-catalog/eventcatalog.svg?style=social

[github-watch]: https://github.com/event-catalog/eventcatalog/watchers

[github-star-badge]: https://img.shields.io/github/stars/event-catalog/eventcatalog.svg?style=social

[github-star]: https://github.com/event-catalog/eventcatalog/stargazers

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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}
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

# License

MIT