Alternate Framework (M Framework)

This repository contains the M Framework — a modular front-end framework and starter templates built with Nuxt and Vue. It provides a collection of themes, layers, packages, and integrations to accelerate building storefronts, apps, and integrations.

Top-level directories

• apps/: Example and production apps that use the framework (for example ecosystem/meeovi).
• layers/: Reusable Nuxt layers (features and verticals) such as auth, commerce, shared, chat, etc. Layers expose application code and can be composed into different apps or themes.
• packages/: Monorepo packages and adapters such as modules, adapters, and other reusable libraries consumed by apps and layers.
• themes/: Theme projects and starter templates. For example themes/framework/starter-template is the default starter theme you can run and extend.
• integrations/: Integration guides, example adapters and compatibility layers for other frameworks, platforms, or runtimes.
• layers/*/app and layers/*/server: Application-level and server-side code that each layer exposes.
• docs/: Documentation content and guides.
• types/: Global TypeScript declarations and shims used across the monorepo.

Quick notes

• The framework is implemented with Nuxt (Nuxt 4) and Vue 3 — components, composables, and pages follow the Nuxt/Vue conventions used in the themes and layers folders.
• Themes (in themes/) are runnable Nuxt projects. To run the starter theme, change into themes/framework/starter-template and run npm install and npm run dev.
• The repository uses a monorepo layout; package installs and scripts may run postinstall hooks. If postinstall scripts fail during root npm install, try installing with --legacy-peer-deps or inspect the package's postinstall script (for example packages/modules/localization).
• Many UI components in this repo depend on third-party UI libraries (e.g., @storefront-ui/vue). Ensure peer dependencies match the workspace Vue version to avoid runtime mismatches.

Where to start

• For theme development: see themes/framework/starter-template/app for pages, components, and layouts.
• For shared building blocks: inspect layers/shared/app and layers/*/app for composables and components.
• For adapter or integration development: look under packages/adapters and integrations/.

If you need help running the starter theme or debugging installs, open an issue or ask in the project chat — common troubleshooting steps are documented in package-level READMEs where applicable.

License: see repository root or individual package manifests for license information.

-- Generated README — concise overview for contributors and maintainers.