How cognizone/ng-cognizone works
Project Type and Purpose
• This is an Nx-powered monorepo hosting multiple Angular applications and libraries under the @cognizone namespace.
• Primary deliverables:
• “docs-app” – an Angular documentation site
• “docs” – a Docusaurus static site project
• “elastic-explorer-chrome-extension” – an Angular-based Chrome extension
• End-to-End test apps (Cypress) for each application
• A large set of reusable, publishable Angular libraries (in libs/) such as UI-kits, data models, domain services, CLI tooling, and core utilities.
• Development support: Storybook for UI components, Jest for unit tests, Cypress for E2E, Husky for git hooks, Prettier/ESLint for formatting & linting, and GitHub Actions for CI/CD.
Top-Level Architectural View
• Inside it, partition into zones:
• Applications (apps/)
• Libraries (libs/)
• Tooling & Scripts (tools/, .github/workflows/, Husky, Nx Cloud config)
• Documentation (docs/, Storybook config)
Main Components
a. Applications Layer (Blue)
• docs-app (Angular SPA)
• docs (Docusaurus site)
• elastic-explorer-chrome-extension (Angular Chrome extension)
• E2E test runners (Cypress projects under apps/*-e2e)
b. Libraries Layer (Green), grouped by domain:
• Angular CDK Helpers: cdk
• Data Models & Services: json-model, json-model-graph, model-utils, elastic, json-ld-core, lod-core, shacl-core
• Domain Profile: application-profile, ng-application-profile, legi-cv, user-action, permissions, operation, seo, i18n, i18n-transloco, transloco-langstring
• Tooling & CLI: cli, eslint-config, prettier-config, tslint-config, html-diff, devtools, seo
c. Tooling & Workflow (Orange)
• Nx CLI orchestrator & dependency graph (nx.json)
• Angular CLI integration
• Jest (unit tests)
• Cypress (E2E tests)
• Storybook (component library preview)
• Husky (git hooks), Prettier & ESLint
• GitHub Actions: CI build (ci.yml), docs deploy (deploy-docs.yml), release pipeline (release.yml)
• Nx Cloud (computation caching)
d. External Services (Purple)
• npm registry (publishing libs)
• GitHub (repo, Actions)
• Browsers (Chrome for extension)
Component Relationships & Data Flows
• Inter-library dependencies (e.g., json-model → lod-core; json-ld-core → json-ld; UI libs → CDK helpers).
• Nx CLI at center orchestrating build/test/lint tasks across apps and libs.
• From Developers’ IDE workstations point to Husky hooks and Nx CLI.
Architectural Patterns & Principles
• Monorepo modularity: clearly separate apps vs. libraries, share code via public API surfaces and importPath="@cognizone/…”.
• “Library-first” design: each feature or domain vector encapsulated as its own npm-publishable package.
• Layered architecture: UI components, core utilities, data models, domain-specific services.
• CI/CD as code: workflows live in .github/workflows, automatic docs deployment and library publishing.
• Dev feedback loops: Storybook, Jest, Cypress, Nx Dependency Graph for instant visibility.