How shopware/meteor works
Project type and purpose
• This is a monorepo for an open-source design system (Meteor) used by Shopware.
File structure
• Top-level:
• docs/ – static authoring of documentation (built via Docusaurus).
• examples/ – sample apps demonstrating usage (admin-sdk app, nuxt app, plugin).
• packages/ – core libraries:
– admin-sdk: JavaScript/TypeScript SDK for building Shopware administration apps.
– component-library: Vue 3 component collection (with Storybook, Vite, test frameworks).
– tokens: tool to fetch design tokens from Figma and produce deliverables (CSS, JSON).
– stylelint-plugin-meteor: Stylelint ruleset for Meteor token conventions.
– prettier-config: shareable Prettier configuration.
• Configuration files at root:
• pnpm-workspace.yaml & turbo.json – workspace & monorepo build orchestrator.
• GitHub workflows – CI pipelines for testing, releasing, visual regression.
• Each package:
• src/ – source code organized by domain/infrastructure or components.
• tests/, e2e/, play-wright/jest/vitest configs – testing layers.
• build scripts & config (tsconfig, vite.config, babel, webpack for examples).
README for additional insights
• README highlights the four primary packages under “packages/” and the examples.
• Contributing and license info.
• No runtime server—most packages are client SDKs or build-time tools.
a. Main components
• Monorepo Root
• Package Modules:
• Admin-SDK
• Component-Library
• Tokens
• Stylelint-Plugin
• Prettier-Config
• Documentation Layer (Docusaurus)
• Example Applications (admin-sdk-app, nuxt-app, plugin)
• External Services:
• NPM Registry (publishing packages)
• GitHub Actions (CI/CD)
b. Relationships & interactions
• Tokens fetch from Figma → produce JSON/CSS → consumed by component-library, stylelint-plugin, admin-sdk.
• Component-library exports Vue components → used by admin-sdk and examples.
• Admin-SDK provides abstractions for Shopware admin apps → examples/admin-sdk-app & plugin depend on it.
• Stylelint-Plugin + Prettier-Config → enforce design and code style across packages and examples.
• CI (GitHub Actions) runs lint, tests (jest, vitest, playwright), visual tests, and publishes to NPM.
c. Architectural patterns & design principles
• Monorepo modularization: logically separated workspaces with shared tooling (pnpm + turborepo).
• Domain-Driven Structure: each package divides code into domain/infrastructure or feature slices.
• Reusability: example apps demonstrate integration and serve as live tests.
d. Key technologies & frameworks
• TypeScript across all packages.
• Vite + Rollup for bundling (libraries & examples).
• Jest, Vitest, Playwright for unit/E2E/visual tests.
• Storybook for component documentation.
• Docusaurus for admin-sdk docs.
• pnpm, turborepo for workspace management.