Installation
Prerequisites
Section titled “Prerequisites”| Tool | Version | Check |
|---|---|---|
| Node.js | 18+ (20 recommended) | node --version |
| npm | 9+ | npm --version |
| Git | 2.30+ | git --version |
| Python | 3.9+ (optional, for validation) | python3 --version |
Clone and install
Section titled “Clone and install”git clone https://github.com/ea-toolkit/architecture-catalog.gitcd architecture-catalogcd catalog-uinpm installVerify the build
Section titled “Verify the build”Before making changes, confirm the project builds with the included sample data:
npm run buildYou should see output like:
Registry loaded: 182 elements, 340 edges Healthy: 182 | Connected: 182 | Orphans: 0 Broken refs: 0286 page(s) builtStart the dev server
Section titled “Start the dev server”npm run devOpen 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.
Brand it for your organization
Section titled “Brand it for your organization”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 logoWhen 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.
Next steps
Section titled “Next steps”- Project Structure — understand the repo layout
- Registry Mapping — learn the schema that drives everything