How ti-tecnologico-de-monterrey-oficial/tec-design-system-ng works
• Design System Library (“ds-ng”): This is the heart of the project. Include sub-components such as:
– UI Components: All “bmb-” prefixed Angular components (e.g., bmb-accordion, bmb-alert-center, etc.). Group them by category (e.g., input elements, layout & navigation, cards, messaging, etc.).
– Directives and Foundations: Capture the folders under “directives” and “foundations” which provide low-level UI behavior and styling resources.
– Services & Utilities: Show the essential services (calendar, theme, toast, user profile, etc.) and utility files that support component functionality.
– Storybook & Testing: In the ds-ng project, a dedicated “.storybook” folder with configuration files and component stories exists; also note all “.spec.ts” files as indicators for testing.
• Demo/Consumer Application (“src/app”): This is the consumer layer using the design system library. It provides sample usage (pages like “home”, “emprendedor”, etc.) of the design system components.
• Build & CI/CD Infrastructure: Recognize the supporting tools such as GitHub Actions workflows (publish.yml, release-package.yml, sonar.yml), commit and pre-commit hooks (.husky), and configuration files (angular.json, tsconfig, package.json). These indicate how the system is built, linted, tested, and deployed.
• External Integrations & Documentation: Include external tooling (Figma for design, Supernova for documentation, GitHub for versioning) as part of the ecosystem that supports the design system’s lifecycle.
Relationships and Interactions
• The Angular design system library encapsulates components, directives, services, and utilities. The library exposes its public API (via projects/ds-ng/src/public-api.ts) which is then consumed by the demo application.
• Components interact with each other when composed within layouts, and they use Angular services for business logic, theme management, and notifications.
• The Storybook setup serves as a live documentation tool. Each component’s stories (with “*.stories.ts” files) demonstrate individual behavior and appearance.
• Build and test workflows (through GitHub Actions and Angular CLI configurations) ensure that changes are automatically validated, and CI processes are clearly defined.
Architectural Patterns and Design Principles
• Component-Based Architecture: The design system splits functionality into reusable UI components that are integrated via Angular’s module system.
• Separation of Concerns: Clearly distinct folders for components, directives, layouts, and services indicate a modular design.
• Test-Driven Development: Every component includes a “component.spec.ts” file, underscoring a commitment to testing.
Relevant Technologies and Frameworks
• Angular (core framework) for component development.
• Storybook for component visualization and documentation.
• SCSS for advanced styling, with centralized token files for themes.
• GitHub Actions and other CI/CD integrations to support build, testing, and deployment workflows.
• TypeScript for code quality and robustness.
• Tools like ESLint, Prettier, and commitlint support code standards and maintainability.
Instructing the Principal Software Engineer
– Rectangles for core modules (DS Library, Storybook, Demo App).