Socket
Socket
Sign inDemoInstall

@eventcatalogtest/core-test

Package Overview
Dependencies
29
Maintainers
0
Versions
110
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@eventcatalogtest/core-test


Version published
Weekly downloads
50
decreased by-71.91%
Maintainers
0
Created
Weekly downloads
ย 

Readme

Source

๐Ÿ“– EventCatalog

Bring discoverability to your event-driven architectures

Discover, Explore and Document your Event Driven Architectures.

MIT License PRs Welcome

All Contributors

Watch on GitHub Star on GitHub


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...

Read the Docs | Edit the Docs | View Demo


Core Features

  • ๐Ÿ“ƒ Document domains, services and messages
  • ๐Ÿ“Š Visualise your architecture
  • โญ Supports any Schema format
  • ๐Ÿ—‚๏ธ Document any code examples (Any Language)
  • ๐Ÿ’… Custom MDX components
  • ๐Ÿ—„๏ธ Content versioning
  • โญ 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.

app.eventcatalog.dev

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

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.

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

๐Ÿ’ป

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

Sponsor

If you like what you see, feel free to sponsor the project.

License

MIT.

FAQs

Last updated on 04 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with โšก๏ธ by Socket Inc