hub / github.com/event-catalog/eventcatalog

github.com/event-catalog/eventcatalog @v3.12.6 sqlite

repository ↗ · DeepWiki ↗ · release v3.12.6 ↗

953 symbols 2,821 edges 329 files 41 documented · 4%

README

EventCatalog

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:

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 Redd}

Extension points exported contracts — how you extend this code

Window (Interface)

(no doc)

eventcatalog/global.d.ts

EventCatalogConfig (Interface)

(no doc)

eventcatalog/src/env.d.ts

EventCatalogAuthConfig (Interface)

(no doc)

src/eventcatalog.auth.ts

Config (Interface)

(no doc)

src/eventcatalog.config.ts

Locals (Interface)

(no doc)

examples/default/middleware.ts

Window (Interface)

(no doc)

eventcatalog/src/env.d.ts

Context (Interface)

(no doc)

eventcatalog/src/types/mcp-modules.d.ts

ToolConfig (Interface)

(no doc)

eventcatalog/src/types/mcp-modules.d.ts

Core symbols most depended-on inside this repo

buildUrl

called by 149

eventcatalog/src/utils/url-builder.ts

generateIdForNode

called by 137

eventcatalog/src/utils/node-graphs/utils/utils.ts

getNestedSideBarData

called by 106

eventcatalog/src/stores/sidebar-store/state.ts

findInMap

called by 51

eventcatalog/src/utils/collections/util.ts

generatedIdForEdge

called by 48

eventcatalog/src/utils/node-graphs/utils/utils.ts

createEdge

called by 45

eventcatalog/src/utils/node-graphs/utils/utils.ts

createVersionedMap

called by 43

eventcatalog/src/utils/collections/util.ts

isSSR

called by 35

eventcatalog/src/utils/feature.ts

Shape

Function 668

Interface 150

Method 87

Class 48

Languages

TypeScript100%

Modules by API surface

eventcatalog/src/utils/feature.ts21 symbols

eventcatalog/src/enterprise/tools/catalog-tools.ts21 symbols

eventcatalog/src/components/SideNav/NestedSideBar/index.tsx21 symbols

eventcatalog/src/utils/collections/util.ts20 symbols

eventcatalog/src/utils/mermaid-zoom.ts17 symbols

eventcatalog/src/components/Tables/Discover/columns.tsx15 symbols

eventcatalog/src/utils/node-graphs/utils/utils.ts14 symbols

eventcatalog/src/enterprise/auth/middleware/middleware-auth.ts14 symbols

eventcatalog/src/components/ChatPanel/ChatPanel.tsx13 symbols

eventcatalog/src/__tests__/middleware-auth.spec.ts13 symbols

eventcatalog/src/types/mcp-modules.d.ts12 symbols

eventcatalog/src/components/SchemaExplorer/JSONSchemaViewer.tsx12 symbols

Dependencies from manifests, versioned

@ai-sdk/react3.0.17 · 1×

@astrojs/check0.9.6 · 1×

@astrojs/markdown-remark6.3.10 · 1×

@astrojs/mdx4.3.13 · 1×

@astrojs/node9.5.2 · 1×

@astrojs/react4.4.2 · 1×

@astrojs/rss4.0.15 · 1×

@astrojs/tailwind6.0.2 · 1×

@asyncapi/avro-schema-parser3.0.24 · 1×

@asyncapi/parser3.4.0 · 1×

@asyncapi/react-component2.4.3 · 1×

@auth/core0.37.4 · 1×

For agents

$ claude mcp add eventcatalog \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact