event-catalog/eventcatalog

EventCatalog란 무엇인가요?

EventCatalog는 소프트웨어 아키텍처 전용으로 설계된 오픈소스 웹 기반 문서 플랫폼입니다. 팀은 도메인, 서비스, 메시지, 스키마, 비즈니스 흐름과 같은 시스템의 구성 요소를 하나의 검색 가능한 UI에서 기록하고 탐색할 수 있습니다.

핵심 기능 (README에 설명됨)

기능	기능 설명	중요성
아키텍처 문서화	도메인, 서비스, 이벤트, 명령, 메시지용 페이지 생성	시스템 구조를 지속적으로 유지하는 '살아있는 지도'를 제공하며, 산만한 마크다운 파일보다 관리가 용이합니다.
AI 기반 탐색	카탈로그에 대한 자연어 질문에 답변하는 내장 챗 인터페이스	엔지니어와 비기술자 모두 정확한 이름을 기억하지 않아도 정보를 빠르게 찾을 수 있습니다.
스키마 탐색기	OpenAPI, AsyncAPI, Protobuf, JSON Schema, Avro 등 인덱싱 및 검색 가능	모든 계약 정의를 한 곳에서 찾을 수 있어 서비스 통합 시 부담을 줄입니다.
스키마 필드 검색	모든 스키마에서 특정 필드 이름을 검색하고 사용 위치 확인	변경의 영향을 평가하고 파괴적 변경을 조기에 탐지할 수 있습니다.
자체 문서 연동	ADR, 런북, 또는 어떤 마크다운/MDX 문서든 카탈로그 엔티티에 첨부 가능	운영 문서를 아키텍처와 함께 버전 관리할 수 있습니다.
비즈니스 흐름 시각화	기존 서비스와 메시지를 참조하는 엔드투엔드 워크플로 다이어그램 작성	제품 소유자와 신입 팀원을 위한 고수준 시각화를 제공합니다.
버전 관리 및 거버넌스	이벤트, 명령, 서비스에 대한 세미틱 버전 관리 및 파괴적 변경 탐지	대규모 분산 팀에서 계약의 안전한 진화를 지원합니다.
생성기	AsyncAPI, OpenAPI, Kafka, Confluent, AWS EventBridge 등 15개 이상의 자동 생성기	기존 인프라 정의에서 카탈로그를 빠르게 시작할 수 있습니다.
사용자 정의 및 기업 기능	테마, MDX 컴포넌트, OAuth2, RBAC, 스키마 거버넌스	기존 보안 및 브랜딩 요구사항에 맞게 통합 가능합니다.

시작하기

# 한 줄 스크래핑 – 새 폴더에 실행 가능한 카탈로그 생성
npx @eventcatalog/create-eventcatalog@latest my-catalog

그런 다음 http://localhost:3000 을 열고 UI 또는 제공된 SDK를 통해 도메인, 서비스, 메시지를 추가하기 시작하세요.

프로젝트 구조 (개요)

패키지	역할
@eventcatalog/core	카탈로그 UI를 렌더링하는 주요 Astro + React 애플리케이션
@eventcatalog/sdk	프로그래밍 방식으로 카탈로그 엔티티 생성, 업데이트, 삭제를 위한 Node.js 라이브러리
@eventcatalog/create-eventcatalog	새 카탈로그 리포지토리를 스크래핑하는 CLI 도구
@eventcatalog/visualiser	카탈로그를 다른 곳에 임베드할 수 있는 독립형 React 컴포넌트

누구에게 적합한가요?

• 이벤트 기반 또는 마이크로서비스 아키텍처의 단일 진실 소스가 필요한 엔지니어 팀
• 코드 리포지토리에서 뒤져야 할 필요 없이 비즈니스 흐름과 런북을 탐색하고 싶은 제품 및 운영 담당자
• RBAC와 버전 관리된 계약을 갖춘 자체 호스팅 가능한 맞춤형 솔루션을 찾는 기업

커뮤니티 및 지원

• 실제 전자상거래, 금융, 헬스케어, SaaS 카탈로그를 보여주는 라이브 데모 사이트
• 문서 사이트: https://www.eventcatalog.dev/docs
• 도움과 기능 논의를 위한 Discord 커뮤니티
• MIT + 상용 라이선스, CI가 정상 작동 중임을 나타내는 배지 (verify-build.yml)

---

TL;DR: EventCatalog는 이벤트 기반 시스템을 포함한 소프트웨어 아키텍처 문서화와 탐색을 위한 목적 지향적 오픈소스 도구입니다. 검색 가능한 스키마 인덱싱, AI 지원 Q&A, 시각적 흐름 다이어그램, 기업 수준의 기능을 현대적인 웹 UI와 npm 패키지 세트로 제공합니다.