Read the Docs | Edit the Docs | View Demo

Core Features

• 🕋 Federation for EventCatalog. Merge many catalogs into one master catalog
• 🧑🏻‍💻 Let your teams control their own catalogs, and merge them into a master catalog
• ⚡️ Git based generator, supports any git repo (e.g GitHub, GitLab, Bitbucket)
• Specify the git repo, it's branch and the files you want to merge into your master catalog
• ✅ Configuration to override files and ensure all files in the catalog are unique

How it works

EventCatalog is technology agnostic, meaning it can integrate with any schemas, specs or brokers.

EventCatalog supports generators. Generators are scripts are run to pre build to generate content in your catalog. Generators can use the EventCatalog SDK.

With this git generator you can connect to many git repos, and merge them into a master catalog.

This let's your teams control their own catalogs, and merge them into a master catalog, keeping the documentation close to the their code.

...
generators: [
    [
      '@eventcatalogtest/generator-federation',
      {
        // The git repo to clone
        source: 'https://github.com/event-catalog/eventcatalog.git',

        // The branch to clone, defaults to main
        branch: 'main',

        // Array of copy configurations - specify what content to copy and where to put it
        copy: [
          {
            // The content to clone, this can be a single file or an array of files
            content: ['/domains'],
            // The destination to clone the content to
            destination: path.join(catalogDir, 'domains'),
          },
          {
            // You can have multiple copy configurations
            content: '/services',
            destination: path.join(catalogDir, 'services'),
          }
        ],

        // Optional: Override existing files (default: false)
        override: false,

        // Optional: Ensure all resources have unique IDs (default: false)
        enforceUniqueResources: false,
      },
    ],
  ],
...

In this example we are:

1. Cloning "domains" from the git repo and merging them into the catalog's domains directory
2. Cloning "services" and merging them into the catalog's services directory

When merging many repositories you can use the override option to override files in the catalog. You can also use the enforceUniqueResources option to ensure all resources in the catalog are unique (to help with naming conflicts).

Getting started

Installation and configuration

Make sure you are on the latest version of EventCatalog.

1. Install the package

@eventcatalog/generator-federation

2. Configure your eventcatalog.config.js file (see example)

3. Run the generate command

npm run generate

4. See your new domains, services and messages, run

npm run dev

Found a problem?

Raise a GitHub issue on this project, or contact us on our Discord server.

Sponsors

Thank you to our project sponsors.

Gold sponsors

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.

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 i
3. Run the examples `npx tsx examples/streelights-mqtt/index.ts
4. Run tests pnpm run tests

Commercial Use

This project is governed by a dual-license. To ensure the sustainability of the project, you can freely make use of this software if your projects are Open Source. Otherwise for internal systems you must obtain a commercial license.

If you would like to obtain a Commercial License, you can purchase a license at https://dashboard.eventcatalog.dev or email us at [email protected]