Skip to content

basic

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

basic

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
public
public
 
 
teams
teams
 
 
users
users
 
 
README.md
README.md
 
 
eventcatalog.config.js
eventcatalog.config.js
 
 
eventcatalog.styles.css
eventcatalog.styles.css
 
 
package.json
package.json
 
 

README.md

EventCatalog GitHub Plugin Example: Basic

This example shows you how to pull and sync schemas from a GitHub schema registry (example used here: https://github.com/event-catalog/flowmart-schema-registry) into EventCatalog.

In this example we pull schemas and assign them to events, commands, and queries.

We have documentation for our events, commands, and queries, and the import persists the markdown between builds.

Features of the GitHub Generator

  • 📃 Pull and sync your schemas from your GitHub repository to EventCatalog
  • 📃 Keep your schemas in sync with your producers and consumers documentation
  • 📃 Supports any schema format (e.g Avro, Protobuf, JSON)
  • 📃 Import all schemas, or specific folders/files
  • ⭐ Go beyond a schema. Add semantic meaning to your schemas, business logic and much more. Help your developers and teams understand the meaning behind the schemas with clear documentation and visualisations.
  • 📊 Visualise producers and consumers in your architecture (demo)
  • ⭐ Download synced schemas from EventCatalog (e.g Avro, Protobuf, JSON) (demo)
  • 📃 Assign schemas to events, commands and queries
  • ⭐ Discoverability feature (search, filter and more) (demo)
  • ⭐ And much more...

To dive into how this plugin can help you, you can read the GitHub Plugin Docs

Prerequisites

Running this example

Once you have this repository cloned, and setup you can run the example.

  1. Run npm install
  2. Get a EventCatalog license key for GitHub integration from EventCatalog Cloud (14 day free trial)
  3. Set the EVENTCATALOG_LICENSE_KEY_GITHUB environment variable in .env file.
EVENTCATALOG_LICENSE_KEY_GITHUB=your-license-key
  1. Generate the catalog (you can see the configuration in eventcatalog.config.js)
npm run generate
  1. Run the catalog locally
npm run dev

You can then view your catalog at http://localhost:3000

Persist documentation between builds

The generator will persist the documentation between builds, so you can keep your documentation up to date.

Try and make a change to the event, command, or query documentation and rerun npm run generate to see the documentation persist.