eventcatalog

把服务、事件和 Schema 整理成可查可读的架构目录

开源 🏷️基础免费,高级付费 ⏳ 访问状态待核验 办公效率 🍴 复刻 283 🐛 待处理 81 👀 关注 22
访问官网 ↗ GitHub ↗
GitHub 星标 ★ 2972
维护状态 活跃
是否开源 开源
定价模式 🏷️基础免费,高级付费 支持限时试用 · 开源版免费,云服务提供免费试用及付费套餐

项目预览

eventcatalog 项目界面预览图
图片来源:项目官网

项目数据

分类办公效率
开发团队event-catalog
定价模式🏷️基础免费,高级付费
价格说明开源版免费,云服务提供免费试用及付费套餐
访问状态⏳ 访问状态待核验
是否开源是
开源协议NOASSERTION
主要语言TypeScript
技术栈/模型ai,architecture,asyncapi,ddd,distributed-systems,documentation,domain-driven-design,event-catalog,event-driven-architecture,microservices
GitHub 星标★ 2972
上线时间2021-11-18 00:00:00
代码更新2026-11-17
仓库体积224.5 MB
本站数据更新2026-11-18
维护状态活跃
收录时间2026-11-18
浏览次数0

项目介绍

EventCatalog 是一个面向软件架构的文档平台,用 TypeScript 编写,专注把领域、服务、事件和 Schema 集中记录成可浏览、可检索的架构目录。它解决分布式系统和事件驱动架构中服务边界模糊、事件契约散落、团队与 AI 代理难以理解系统全貌的问题。核心能力包括:以领域驱动设计视角组织服务与事件,支持 AsyncAPI 等 Schema 展示,自动生成可视化架构关系,提供文档站点与搜索,并让 AI 代理读取结构化架构信息辅助开发。项目在 GitHub 已有约三千星,处于成长阶段,适合需要长期维护架构文档的团队。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整

数据来源:GitHub API 逐日快照 · 收录于 2026-11-18 · 当前星标 ★ 2972

使用教程

难度:入门 约 10 分钟 部署方式:命令行工具 4 步

环境要求

  • 已安装 Node.js(自带 npm/npx),建议使用 LTS 版本
  • 终端可正常访问 npm 软件源以下载脚手架包
  • 本机 3000 端口未被占用
  • 可正常访问 http://localhost:3000 的现代浏览器

安装与启动步骤

  1. 1确认 Node 环境

    在终端确认 node 与 npx 可用,版本过低时先升级 Node.js 再继续。

    node -v
    npx -v
  2. 2生成架构目录项目

    执行脚手架命令,npx 会下载 create-eventcatalog 并在当前目录生成 my-catalog 项目。

    npx @eventcatalog/create-eventcatalog@latest my-catalog
  3. 3进入项目目录

    切换到刚生成的目录,后续操作都在此目录内进行。

    cd my-catalog
  4. 4打开本地站点

    按脚手架提示访问本地地址,即可开始记录领域、服务、事件与 Schema。

如何确认成功

浏览器打开 http://localhost:3000,能看到 EventCatalog 目录首页即表示启动成功。

常见问题

Q:执行 npx 提示命令不存在怎么办?

A:说明本机未安装 Node.js 或未加入 PATH,先安装 Node.js LTS 版本,再重新打开终端执行命令。

Q:页面打不开、无法连接?

A:确认终端中的服务进程仍在运行,并检查 http://localhost:3000 地址与端口是否被其他程序占用。

Q:my-catalog 这个名字可以改吗?

A:可以,它就是新项目目录名,换成你想要的名字,后续 cd 进入对应目录即可。

Q:想了解更详细的配置方法?

A:参考官网 Getting Started 文档与在线示例站点,按其中的说明继续配置。

注意事项

  • 首次执行会在 npm 源下载脚手架包,网络较慢时耐心等待。
  • 命令需在终端中执行,不要在浏览器地址栏输入。
  • 项目为 source-available 授权,商用前请阅读仓库中的许可条款。

核心亮点

  • 以领域、服务、事件为中心组织文档,贴合事件驱动与 DDD 实践
  • 支持 AsyncAPI 等 Schema 展示,契约与文档同处一处
  • 内置可视化架构关系与站点搜索,降低跨团队理解成本

不足之处

  • 项目仍在成长阶段,生态与周边工具尚不丰富
  • 深度定制和复杂架构场景需要一定前端与配置能力

适用场景

  • 事件驱动微服务团队统一维护服务与事件契约文档
  • 新成员快速了解系统领域划分和服务依赖关系
  • 为 AI 编码助手提供结构化架构上下文

替代项目

Backstage、Structurizr、Docusaurus

上一篇:yogurt

下一篇:没有了!

同类项目推荐

compdf-self-hosted 开源

私有部署的 PDF 全能工具箱,转格式、加解密、OCR 一站搞定

Edit, convert, and transform documents across PDFs, Office formats, HTML, TXT, CSV, ···

★ 150 2026-09-30
NexQ 开源

本地实时转写会议,AI 秒回要点提示

Open-source, local-first AI meeting assistant & real-time interview copilot for Wind···

★ 130 2026-11-08
anything-copilot 开源

把任意网站塞进侧边栏,多标签切换不迷路

Anything Copilot enables you to open any sites in a multi-tab sidebar or popup, enha···

★ 95 2026-08-09
MeetingCopilot 开源

会议面试实时转写,悬浮提词给答案

Real-time stealth meeting/interview copilot for Windows - streaming ASR (local FunAS···

★ 417 2026-11-04
ServiceNowDocs 开源

官方 ServiceNow 文档,直接喂给大模型做知识库

ServiceNow AI Platform documentation for LLM consumption.

★ 559 2026-09-16
slidev-ai 开源

输入主题,AI 自动生成 Slidev 幻灯片,省时省力

ai app for slidev

★ 284 2026-08-09
siyuan-plugin-copilot 开源

在思源笔记里直接问 AI、改文字、跑工具

思源笔记AI Copilot插件,支持基于思源笔记进行AI问答和编辑,支持agent模式调用工具

★ 162 2026-11-06
pdf-extractor 开源

一键将 PDF 页面转为图片、SVG、文本和 JSON。

Node.js module for rendering pdf pages to images, svgs, html files, text files and j···

★ 107 2026-08-09
pd3f 开源

把 PDF 转成干净段落文本,去掉页眉页脚和断词

PDF text extraction: paragraphs, hyphens, headers and footers, footnotes, OCR. Pytho···

★ 337 2026-10-30