How wai-technologies/raaghu-react works
Main Components
• UI Component Libraries – Display separate packages:
• Raaghu Components: The core set of React UI components (with subdirectories for a wide range of components).
• Raaghu Elements: More granular elements (found under “raaghu-elements” with its own testing, build configuration, etc.).
• Raaghu Layouts: Components used for app shells and layout management.
• Raaghu Pages: Demo or example pages that integrate the design system.
• Raaghu React Themes: The thematic layer (styles, assets, and theme configurations).
• Documentation & Demo:
• Storybook: Used for testing, visual documentation, and design inspection.
• Online Docs & README: Provide detailed guidance on component usage and integration.
• Build & Continuous Integration:
• CI/CD Pipelines: GitHub workflows (npm_publish.yml, storybookreact.yml, etc.) run tests, build, and deploy packages.
• Build Tools: Rollup configuration in each package and Vite used in “raaghu-pages”.
• Design & Integration:
• Figma and Figma Code Connect: Not in the code per se, but an external integration point that links the Figma design kit with code components.
• Chromatic visual testing pipelines: Ensuring component quality.
• Development Tooling & Utilities:
• Various configuration files (.eslintrc, tsconfig, npm configs) and utility scripts (install-all.js, start-scripts.js) that set up the local development environment and deploy flows.
Relationships and Interactions
• The “raaghu-components” package provides building blocks that “raaghu-pages” (or demo apps) use.
• The “raaghu-react-themes” package supplies theming data and style configurations that are used by the component libraries.
• CI/CD pipelines (GitHub workflows) are connected to the packages: they trigger tests (Chromatic, Jest), build processes (Rollup, Vite), and ultimately publish updated packages to npm.
• External integration with Figma is an “input” channel: Designers update Figma assets/design kits that later integrate into the system via Figma Code Connect.
Architectural Patterns and Design Principles
• Modular & Component‐Driven Architecture: Separate packages encapsulate UI components, layouts, themes, and pages.
• Separation of Concerns: Design artifacts (Figma, design tokens) are connected to code through specialized integrations.
• CI/CD and Automated Testing: Emphasize the use of GitHub workflows and visual testing (Chromatic) to ensure component quality.
• Use of Modern Build Tools: Vite and Rollup streamline bundling while TypeScript enforces strong typing across modules.
Relevant Technologies
• React and TypeScript as the core languages.
• Storybook for component documentation.
• Vite (for “raaghu-pages”) and Rollup (for building component libraries) as the bundlers.
• CI/CD using GitHub Actions, with configuration files from .github/workflows.
• Figma integration (through design kits and Figma Code Connect).
• Chromatic for visual regression testing.