Skip to main content

Installation

Create a new EventCatalog and run it locally.

System Requirements​

  • Node.js v22 or higher (check with node -v)

Create with the CLI​

The quickest way to create a new EventCatalog is using create-eventcatalog, which sets up everything automatically for you. To create a project, run:

npx @eventcatalog/create-eventcatalog@latest my-catalog

This creates a my-catalog directory with everything you need.

Start the dev server​

Once the project is created, navigate to the project directory and start the development server.

cd my-catalog
npm run dev

Open http://localhost:3000 to see your catalog.

Next steps​