Skip to content

Installation

ToolVersionCheck
Node.js18+ (20 recommended)node --version
npm9+npm --version
Git2.30+git --version
Python3.9+ (optional, for validation)python3 --version
Terminal window
git clone https://github.com/ea-toolkit/architecture-catalog.git
cd architecture-catalog
cd catalog-ui
npm install

Before making changes, confirm the project builds with the included sample data:

Terminal window
npm run build

You should see output like:

Registry loaded: 182 elements, 340 edges
Healthy: 182 | Connected: 182 | Orphans: 0
Broken refs: 0
286 page(s) built
Terminal window
npm run dev

Open http://localhost:4321. You should see the dashboard with 6 sample domains including Customer Management, Billing & Payments, Analytics & Insights, Integration & Connectivity, Security & Compliance, and Platform Operations.

Open models/registry-mapping.yaml and update the site: section:

site:
name: Architecture Catalog # subtitle / catalog name
company: Acme Corp # main heading on homepage
description: Enterprise architecture registry
logo_text: A # single character in sidebar logo

When company is set, the homepage shows it as the main title with the catalog name as subtitle. Restart the dev server and your branding is applied everywhere.