Skip to content

MasterFabric represents the architecture of e-commerce mobile apps.Enterprise-level Flutter development.

License

Notifications You must be signed in to change notification settings

masterfabric-mobile/osmea

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

OSMEA ยฎ๏ธ

Open Source Mobile E-commerce App Builder Tool

Version Platform Firebase Shopify WooCommerce Supabase REST API GraphQL GitHub stars GitHub forks GitHub issues GitHub pull requests GitHub contributors GitHub last commit GitHub commit activity License

OSMEA Banner

"OSMEA is not just a framework โ€” it's an ecosystem."

๐Ÿš€ Live Demo โ€ข ๐Ÿ“š Documentation โ€ข ๐Ÿ” API Explorer โ€ข ๐ŸŽฎ Component Showcase


๐Ÿ“‹ Table of Contents


๐Ÿ“Š Project Statistics

Metric Value Metric Value
โญ GitHub Stars 101+ ๐Ÿด Forks 23+
๐Ÿ“‚ Core Packages 3 ๐Ÿš€ Applications 6
๐Ÿ› Open Issues 7 ๐Ÿ‘ฅ Contributors Active
๐Ÿ“… Last Updated Recently ๐Ÿข License AGPL v3.0

๐ŸŽฏ Topics: ecommerce flutter mobile shopify woocommerce supabase

๐ŸŒ Homepage: https://osmea.masterfabric.co


๐ŸŒŸ What is OSMEA?

OSMEA (Open Source Mobile E-commerce Architecture) is a comprehensive Flutter ecosystem for building enterprise-level e-commerce mobile applications. MasterFabric represents the architecture of e-commerce mobile apps with professional, production-ready solutions.

๐ŸŽฏ Our Mission

"To provide the ultimate toolkit for Flutter developers to build world-class e-commerce applications faster than ever before."

โšก Why Choose OSMEA?

  • ๐Ÿ—๏ธ Enterprise Architecture - Production-ready, scalable structure
  • ๐Ÿ”ง 3 Core Packages - APIs, Components, Core utilities
  • ๐Ÿš€ 6 Ready Apps - Complete applications for different use cases
  • ๐Ÿ“ฑ Cross-Platform - iOS, Android, Web, Desktop support
  • ๐Ÿ›’ E-commerce Focused - Built specifically for commerce apps
  • โš™๏ธ Automated Setup - One-command project initialization with setup.sh
  • ๐Ÿ”Œ Multi-Platform Integration - Shopify, WooCommerce, Supabase support
  • ๐ŸŽจ 50+ UI Components - Material Design 3 components ready to use
  • ๐Ÿงช Testing Framework - Comprehensive testing tools included
  • ๐Ÿ“š Rich Documentation - Detailed guides, checklists, and examples

๐Ÿ—๏ธ OSMEA Ecosystem Architecture

๐Ÿ“ฆ Core Packages (3)

๐ŸŒ APIs

Backend integration | โœ… Production Ready
REST/GraphQL โ€ข Shopify โ€ข WooCommerce โ€ข Auth โ€ข Error handling

๐ŸŽจ Components

UI component library | โœ… Production Ready
50+ components โ€ข Material Design 3 โ€ข Responsive layouts

๐Ÿ”ง Core

Foundation utilities | โœ… Production Ready
DI โ€ข Storage โ€ข Analytics โ€ข Theming โ€ข i18n support

๐Ÿš€ Ready-to-Use Applications (6)

Application Platform Status Purpose
๐Ÿ“Š Admin Dashboard Web ๐Ÿ”„ Development Management interface with analytics
๐Ÿ” API Explorer Web โœ… Ready API testing & debugging tool
๐ŸŽฎ Components App All Platforms โœ… Ready Interactive component showcase
๐Ÿ›๏ธ Storefront Supabase iOS/Android ๐Ÿ”„ Development Supabase-powered e-commerce app
๐Ÿ›’ Storefront Woo iOS/Android ๐Ÿ”„ Development WooCommerce integration app
๐Ÿ“– Storybook Web โœ… Ready Component documentation hub

๐Ÿ› ๏ธ Development Tools


๐Ÿ› ๏ธ Technology Stack

Frontend & Mobile

  • Flutter 3.19+ - Cross-platform framework with native performance
  • Dart - Primary language (99.4% of codebase)
  • Material Design 3 - Modern design system with adaptive theming
  • BLoC Pattern - Predictable state management for scalable apps

Backend & APIs

  • REST APIs - RESTful service integration with robust error handling
  • GraphQL - Modern API query language for efficient data fetching
  • Firebase - Backend services, analytics, and real-time features
  • Authentication - OAuth 2.0, JWT, and API key support

E-commerce Platforms

  • Shopify - Full REST and GraphQL API integration
  • WooCommerce - WordPress e-commerce platform support
  • Supabase - Open source Firebase alternative
  • Custom APIs - Flexible integration layer for any backend

Development & DevOps

  • GitHub Actions - CI/CD pipelines for automated deployment
  • TypeScript (0.4%) - Tooling and configuration scripts
  • Shell Scripts (0.1%) - Automation with setup.sh
  • Ruby (0.1%) - Fastlane deployment automation
  • Flutter Test - Comprehensive testing suite
  • Flutter Lints - Code quality enforcement

โœจ Key Features & Benefits

๐Ÿš€ Developer Experience

  • โšก Rapid Development - Build 70% faster with pre-built components and templates
  • ๐Ÿ”ง Modular Architecture - Use only what you need, plug-and-play design
  • โš™๏ธ One-Command Setup - Automated project initialization with setup.sh
  • ๐Ÿ“š Rich Documentation - Comprehensive guides, checklists, and API references
  • ๐Ÿงช Built-in Testing - Unit, widget, and integration test frameworks included
  • ๐ŸŽฏ Type Safety - Full type safety with Dart for robust applications
  • ๐Ÿ”„ Hot Reload - Instant feedback during development
  • ๐Ÿ“‹ Development Rules - Coding standards and best practices included

๐Ÿ›’ E-commerce Features

  • ๐Ÿช Multi-Platform Support - Shopify, WooCommerce, Supabase integrations
  • ๐ŸŽจ 50+ UI Components - Production-ready e-commerce UI components
  • ๐Ÿ” Authentication System - Secure user management and session handling
  • ๐Ÿ“Š Analytics Integration - Firebase Analytics built-in for insights
  • ๐Ÿ’ณ Payment Processing - Multiple gateway support (Stripe, PayPal, etc.)
  • ๐Ÿ›๏ธ Product Management - Catalog, search, filtering, and cart functionality
  • ๐Ÿ“ฆ Order Processing - Complete order management and tracking
  • โญ Wishlist Support - Save and manage favorite items

๐Ÿ“ฑ Cross-Platform Excellence

  • ๐Ÿ“ฑ Native Performance - iOS and Android optimization for smooth experience
  • ๐ŸŒ Web Support - Progressive Web App (PWA) with responsive design
  • ๐Ÿ–ฅ๏ธ Desktop Ready - Windows, macOS, Linux support from single codebase
  • ๐ŸŽจ Adaptive UI - Automatic platform-specific styling and behaviors
  • ๐ŸŒ Internationalization - Multi-language support with slang integration
  • ๐Ÿ“ Responsive Layouts - Works beautifully on all screen sizes
  • ๐ŸŽฏ Material Design 3 - Modern design system with dynamic theming
  • ๐Ÿ”„ Offline Support - Core functionality available without internet

๐Ÿ“š Architecture & Documentation

๐Ÿ—๏ธ Project Structure

osmea/
โ”œโ”€โ”€ ๐Ÿ“ฆ packages/                    # 3 Core Packages
โ”‚   โ”œโ”€โ”€ apis/                       # API integration layer
โ”‚   โ”‚   โ”œโ”€โ”€ lib/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ src/
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ shopify/       # Shopify API integration
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ woocommerce/   # WooCommerce API integration
โ”‚   โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ core/          # Shared API utilities
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ apis.dart
โ”‚   โ”‚   โ”œโ”€โ”€ analysis_options.yaml
โ”‚   โ”‚   โ”œโ”€โ”€ build.yaml
โ”‚   โ”‚   โ”œโ”€โ”€ codegen.yaml
โ”‚   โ”‚   โ””โ”€โ”€ pubspec.yaml
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ components/                 # UI component library
โ”‚   โ”‚   โ”œโ”€โ”€ lib/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ src/
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ buttons/       # Button components
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ cards/         # Card components
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ forms/         # Form components
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ layouts/       # Layout components
โ”‚   โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ navigation/    # Navigation components
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ components.dart
โ”‚   โ”‚   โ”œโ”€โ”€ assets/                # Component assets
โ”‚   โ”‚   โ””โ”€โ”€ pubspec.yaml
โ”‚   โ”‚
โ”‚   โ””โ”€โ”€ core/                       # Foundation utilities
โ”‚       โ”œโ”€โ”€ lib/
โ”‚       โ”‚   โ”œโ”€โ”€ src/
โ”‚       โ”‚   โ”‚   โ”œโ”€โ”€ analytics/     # Firebase Analytics
โ”‚       โ”‚   โ”‚   โ”œโ”€โ”€ auth/          # Authentication
โ”‚       โ”‚   โ”‚   โ”œโ”€โ”€ di/            # Dependency Injection
โ”‚       โ”‚   โ”‚   โ”œโ”€โ”€ i18n/          # Internationalization
โ”‚       โ”‚   โ”‚   โ”œโ”€โ”€ storage/       # Local storage
โ”‚       โ”‚   โ”‚   โ””โ”€โ”€ theme/         # Theme system
โ”‚       โ”‚   โ””โ”€โ”€ core.dart
โ”‚       โ”œโ”€โ”€ assets/                # Core assets
โ”‚       โ”œโ”€โ”€ slang.yaml            # i18n configuration
โ”‚       โ””โ”€โ”€ pubspec.yaml
โ”‚
โ”œโ”€โ”€ ๐Ÿš€ projects/                    # 6 Ready-to-Use Applications
โ”‚   โ”œโ”€โ”€ admin_dashboard/            # ๐Ÿ“Š Management interface (Web)
โ”‚   โ”‚   โ”œโ”€โ”€ lib/
โ”‚   โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ””โ”€โ”€ pubspec.yaml
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ api_explorer/               # ๐Ÿ” API testing tool (Web)
โ”‚   โ”‚   โ”œโ”€โ”€ lib/
โ”‚   โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ””โ”€โ”€ pubspec.yaml
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ components_app/             # ๐ŸŽฎ Component showcase (All platforms)
โ”‚   โ”‚   โ”œโ”€โ”€ lib/
โ”‚   โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ”œโ”€โ”€ android/
โ”‚   โ”‚   โ”œโ”€โ”€ ios/
โ”‚   โ”‚   โ””โ”€โ”€ pubspec.yaml
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ storefront_supabase/        # ๐Ÿ›๏ธ Supabase e-commerce (Mobile)
โ”‚   โ”‚   โ”œโ”€โ”€ lib/
โ”‚   โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ”œโ”€โ”€ android/
โ”‚   โ”‚   โ”œโ”€โ”€ ios/
โ”‚   โ”‚   โ””โ”€โ”€ pubspec.yaml
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ storefront_woo/             # ๐Ÿ›’ WooCommerce app (Mobile)
โ”‚   โ”‚   โ”œโ”€โ”€ lib/
โ”‚   โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ”œโ”€โ”€ android/
โ”‚   โ”‚   โ”œโ”€โ”€ ios/
โ”‚   โ”‚   โ””โ”€โ”€ pubspec.yaml
โ”‚   โ”‚
โ”‚   โ””โ”€โ”€ storybook/                  # ๐Ÿ“– Documentation hub (Web)
โ”‚       โ”œโ”€โ”€ lib/
โ”‚       โ”œโ”€โ”€ assets/
โ”‚       โ””โ”€โ”€ pubspec.yaml
โ”‚
โ”œโ”€โ”€ ๐Ÿ“š docs/                        # Documentation & Resources
โ”‚   โ”œโ”€โ”€ assets/                     # Images, logos, banners
โ”‚   โ”œโ”€โ”€ checklists/                 # Development checklists
โ”‚   โ”‚   โ”œโ”€โ”€ core_components_checklist.md
โ”‚   โ”‚   โ”œโ”€โ”€ layout_utilities_checklist.md
โ”‚   โ”‚   โ”œโ”€โ”€ shopify_rest_api_checklist.md
โ”‚   โ”‚   โ”œโ”€โ”€ woocommerce_api_postman_checklist.md
โ”‚   โ”‚   โ””โ”€โ”€ woocommerce_rest_api_checklist.md
โ”‚   โ”œโ”€โ”€ guidance/                   # Setup & configuration guides
โ”‚   โ”‚   โ”œโ”€โ”€ permission_handler_guidance.md
โ”‚   โ”‚   โ”œโ”€โ”€ woocommerce_setup_guide_macos.md
โ”‚   โ”‚   โ”œโ”€โ”€ woocommerce_setup_guide_windows.md
โ”‚   โ”‚   โ””โ”€โ”€ woocommerce_wishlist_plugin_guide.md
โ”‚   โ”œโ”€โ”€ plugins/                    # Plugin documentation
โ”‚   โ”‚   โ”œโ”€โ”€ masterfabric-wishlist/
โ”‚   โ”‚   โ””โ”€โ”€ osmea-app-config-manager/
โ”‚   โ””โ”€โ”€ versions/                   # Version logs & release notes
โ”‚       โ””โ”€โ”€ version-logs.md
โ”‚
โ”œโ”€โ”€ ๐ŸŒ website/                     # Project website (Next.js)
โ”‚   โ”œโ”€โ”€ src/
โ”‚   โ”‚   โ”œโ”€โ”€ app/
โ”‚   โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ””โ”€โ”€ styles/
โ”‚   โ”œโ”€โ”€ public/
โ”‚   โ”œโ”€โ”€ package.json
โ”‚   โ”œโ”€โ”€ next.config.ts
โ”‚   โ””โ”€โ”€ tsconfig.json
โ”‚
โ”œโ”€โ”€ ๐Ÿ“‹ rules/                       # Development rules & guidelines
โ”‚   โ”œโ”€โ”€ osmea_components_usage.cursorrules
โ”‚   โ”œโ”€โ”€ osmea-apis-network.cursorrules
โ”‚   โ”œโ”€โ”€ osmea-color-system.cursorrules
โ”‚   โ”œโ”€โ”€ osmea-components-ui.cursorrules
โ”‚   โ”œโ”€โ”€ osmea-core-foundation.cursorrules
โ”‚   โ”œโ”€โ”€ osmea-packages-general.cursorrules
โ”‚   โ”œโ”€โ”€ osmea-sizer-extensions.cursorrules
โ”‚   โ”œโ”€โ”€ osmea-text-extensions.cursorrules
โ”‚   โ”œโ”€โ”€ osmea-text-system.cursorrules
โ”‚   โ””โ”€โ”€ osmea-website-nextjs.cursorrules
โ”‚
โ”œโ”€โ”€ โš™๏ธ setup.sh                     # Automated setup script
โ”œโ”€โ”€ ๐Ÿ“„ README.md                    # This file
โ”œโ”€โ”€ ๐Ÿ“‹ CONTRIBUTING.md              # Contribution guidelines
โ”œโ”€โ”€ ๐Ÿ“œ CODE_OF_CONDUCT.md           # Community standards
โ”œโ”€โ”€ ๐Ÿ”’ SECURITY.md                  # Security policy
โ”œโ”€โ”€ โš–๏ธ LICENSE                      # AGPL v3.0 license
โ”œโ”€โ”€ ๐Ÿ“ commits.md                   # Commit message guidelines
โ””โ”€โ”€ ๐Ÿ“‹ pull_request_template.md     # PR template

๐Ÿ“– Documentation Hub

OSMEA provides comprehensive documentation organized into several categories:

๐Ÿ“‹ Checklists - docs/checklists/

Step-by-step guides for implementation and verification:

  • Core Components - UI component implementation checklist
  • Layout Utilities - Responsive layout system guide
  • Shopify REST API - Shopify integration checklist
  • WooCommerce API - WooCommerce setup and testing
  • Postman Collections - API testing with Postman

๐ŸŽฏ Guidance - docs/guidance/

Detailed setup and configuration tutorials:

  • Permission Handler - Mobile permissions setup
  • WooCommerce Setup - macOS and Windows guides
  • Wishlist Plugin - WordPress plugin integration

๐Ÿ”Œ Plugins - docs/plugins/

Custom plugin documentation:

  • MasterFabric Wishlist - WordPress wishlist plugin
  • OSMEA App Config Manager - App configuration plugin

๐Ÿ“Š Versions - docs/versions/

Release notes and version history:

  • Version logs with detailed changelogs
  • Migration guides between versions

๐Ÿง  Architecture Principles

OSMEA follows industry best practices and design principles:

Principle Implementation Benefits
๐Ÿ›๏ธ Clean Architecture Separation of Concerns, Domain-Driven Design, Dependency Rule Clear layer boundaries, business logic isolation, testability
โšก SOLID Principles Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, Dependency Inversion Maintainable code, easy to extend, reduced coupling
๐Ÿ”„ State Management BLoC Pattern, Predictable State, Reactive Programming Clear state transitions, stream-based architecture, scalability
๐Ÿ’‰ Dependency Injection Injectable code generation, GetIt service locator Loose coupling, easy testing, flexible architecture
๐Ÿงฉ Modular Design Package structure, Plugin architecture, Composition over inheritance Extensible system, reusable components, maintainability

๐Ÿš€ Getting Started

๐Ÿ“‹ Prerequisites

  • Flutter SDK 3.19.0 or higher (Install Flutter)
  • Dart SDK 2.17.0 or higher (comes with Flutter)
  • Git for version control
  • Android Studio or VS Code with Flutter extensions
  • Xcode (for iOS development on macOS)
  • Node.js (for website development)

โšก Quick Start (Recommended)

Option 1: Automated Setup (Fastest)

# Clone the repository
git clone https://github.com/masterfabric-mobile/osmea.git
cd osmea

# Run automated setup script
chmod +x setup.sh
./setup.sh

# Start developing! ๐Ÿš€

The setup.sh script will:

  • โœ… Install all package dependencies
  • โœ… Generate required code files
  • โœ… Set up project configurations
  • โœ… Verify Flutter installation
  • โœ… Run initial health checks

Option 2: Manual Setup

# Install core package dependencies
cd packages/core && flutter pub get && cd ../..
cd packages/apis && flutter pub get && cd ../..
cd packages/components && flutter pub get && cd ../..

# Generate code with build_runner
cd packages/apis && flutter pub run build_runner build --delete-conflicting-outputs && cd ../..
cd packages/core && flutter pub run build_runner build --delete-conflicting-outputs && cd ../..

# Install application dependencies
cd projects/components_app && flutter pub get && cd ../..
cd projects/storefront_woo && flutter pub get && cd ../..

Option 3: Try Live Demos

Experience OSMEA without installation:

๐ŸŽฏ Choose Your Application

# For interactive component showcase
cd projects/components_app
flutter run

# For API testing and exploration
cd projects/api_explorer
flutter run --platform web

# For WooCommerce storefront
cd projects/storefront_woo
flutter run --flavor dev  # Development environment
flutter run --flavor prod # Production environment

# For Supabase storefront
cd projects/storefront_supabase
flutter run

# For component documentation
cd projects/storybook
flutter run --platform web

# For admin dashboard
cd projects/admin_dashboard
flutter run --platform web

๐Ÿ› ๏ธ Development Commands

# Run tests
flutter test

# Generate code (after model changes)
flutter pub run build_runner build --delete-conflicting-outputs

# Build for production
flutter build apk --release      # Android
flutter build ios --release      # iOS
flutter build web --release      # Web
flutter build macos --release    # macOS
flutter build windows --release  # Windows
flutter build linux --release    # Linux

# Format code
flutter format .

# Analyze code
flutter analyze

๐Ÿ“ฆ Package Details

๐ŸŽจ OSMEA Components

50+ production-ready UI components for building beautiful Flutter applications.

Key Features:

  • ๐ŸŽจ Rich Component Library: Buttons, cards, forms, layouts, navigation
  • ๐Ÿ“ฑ Responsive Design: Mobile-first with adaptive layouts
  • ๐ŸŽฏ Type Safe: Full type safety with Dart
  • ๐Ÿ”ง Highly Customizable: Extensive theming and styling options
  • โ™ฟ Accessible: WCAG compliance and screen reader support
  • ๐ŸŽจ Material Design 3: Latest design system implementation

Component Categories:

  • Buttons: Primary, secondary, text, icon, floating action buttons
  • Cards: Product cards, content cards, media cards
  • Forms: Text fields, dropdowns, checkboxes, radio buttons
  • Layouts: Grids, lists, responsive containers
  • Navigation: Bottom bars, app bars, drawers, tabs
  • Feedback: Snackbars, dialogs, loading indicators
  • E-commerce: Product cards, cart items, checkout forms

Usage:

dependencies:
  osmea_components:
    git:
      url: https://github.com/masterfabric-mobile/osmea.git
      path: packages/components

๐Ÿ”ง OSMEA Core

Essential utilities, base classes, and shared logic for OSMEA applications.

Key Features:

  • ๐Ÿ—๏ธ Clean Architecture: Structured foundation for scalable apps
  • ๐ŸŒ Internationalization: Multi-language support with slang
  • ๐Ÿ’พ Storage Solutions: Local storage, preferences, secure storage
  • ๐Ÿ” Authentication: User management and session handling
  • ๐Ÿ“Š Analytics: Firebase Analytics integration
  • ๐ŸŽจ Dynamic Theming: Runtime theme switching and customization
  • ๐Ÿ”ง Dependency Injection: Injectable-based DI setup

Core Modules:

  • Analytics: Firebase Analytics tracking and events
  • Auth: Authentication providers and user management
  • DI: Dependency injection configuration
  • i18n: Internationalization with slang
  • Storage: Local data persistence
  • Theme: Dynamic theme system with Material Design 3
  • Utils: Helper functions and extensions

Usage:

dependencies:
  core:
    git:
      url: https://github.com/masterfabric-mobile/osmea.git
      path: packages/core

๐ŸŒ OSMEA APIs

Comprehensive API network layer for e-commerce applications.

Key Features:

  • ๐Ÿ›’ Multi-Platform: Shopify, WooCommerce, Supabase integrations
  • ๐Ÿ”„ Dual Protocol: REST and GraphQL support
  • ๐Ÿ” Security First: OAuth 2.0, JWT, API key authentication
  • ๐Ÿ“ Request Logging: Network debugging and monitoring
  • ๐Ÿ”ง DI Architecture: Injectable-based service layer
  • ๐Ÿ›ก๏ธ Error Handling: Comprehensive error management
  • โšก Performance: Request caching and rate limiting

Supported Platforms:

  • Shopify: Full REST and GraphQL API integration
  • WooCommerce: Complete WordPress e-commerce API
  • Supabase: Open source backend integration
  • Custom APIs: Flexible adapter pattern for any backend

API Features:

  • Products: CRUD operations, search, filtering
  • Orders: Order management, status tracking
  • Customers: User authentication and profiles
  • Cart: Shopping cart operations
  • Payments: Payment gateway integration
  • Webhooks: Event-driven updates

Usage:

dependencies:
  apis:
    git:
      url: https://github.com/masterfabric-mobile/osmea.git
      path: packages/apis

๐Ÿš€ Application Showcase

๐Ÿ“Š Admin Dashboard - Management interface | ๐ŸŒ Web | ๐Ÿ”„ In Development

Comprehensive management interface for e-commerce operations

Purpose: Store management, analytics, and administration

Key Features:

  • ๐Ÿ“Š Analytics Dashboard: Sales metrics, customer insights
  • ๐Ÿ“ฆ Product Management: CRUD operations, inventory tracking
  • ๐Ÿ‘ฅ Customer Profiles: User management and history
  • ๐Ÿ›’ Order Processing: Order management and fulfillment
  • ๐Ÿ’ฐ Revenue Tracking: Financial reports and analytics
  • โš™๏ธ Settings: Store configuration and preferences
๐Ÿ” API Explorer - API testing tool | ๐ŸŒ Web | โœ… Production Ready

Interactive API testing and exploration tool

Purpose: API testing, debugging, and documentation

Key Features:

  • ๐Ÿ”Œ Multi-Platform Support: Test Shopify, WooCommerce, Supabase APIs
  • ๐Ÿ“ Request Builder: Interactive API request construction
  • ๐Ÿ› Debugging Tools: Network inspection and error analysis
  • ๐Ÿ“Š Response Viewer: JSON formatter and visualizer
  • ๐Ÿ’พ Request History: Save and replay API requests
  • ๐Ÿ“š API Documentation: Integrated API reference
๐ŸŽฎ Components App - Interactive showcase | ๐Ÿ“ฑ All Platforms | โœ… Production Ready | ๐Ÿš€ Live Demo

Interactive showcase of all OSMEA components

Purpose: Component exploration and testing

Key Features:

  • ๐ŸŽจ Live Preview: Real-time component rendering
  • ๐ŸŽ›๏ธ Customization Controls: Interactive property adjustment
  • ๐Ÿ“ฑ Responsive Testing: View on different screen sizes
  • ๐ŸŽจ Theme Switching: Test light and dark themes
  • ๐Ÿ“‹ Code Examples: Copy-paste ready code snippets
  • ๐Ÿ” Search: Quick component discovery

๐ŸŒ Try it now: https://components.masterfabric.co

๐Ÿ›๏ธ Storefront Supabase - Supabase e-commerce | ๐Ÿ“ฑ iOS, Android | ๐Ÿ”„ In Development

Modern e-commerce app powered by Supabase

Purpose: Full-featured e-commerce mobile application

Key Features:

  • ๐Ÿช Product Catalog: Browse, search, filter products
  • ๐Ÿ›’ Shopping Cart: Add, remove, update quantities
  • ๐Ÿ’ณ Checkout: Secure payment processing
  • ๐Ÿ‘ค User Accounts: Registration, login, profiles
  • ๐Ÿ“ฆ Order History: Track orders and shipments
  • โญ Wishlist: Save favorite products
  • ๐Ÿ”” Push Notifications: Order updates and promotions
๐Ÿ›’ Storefront Woo - WooCommerce app | ๐Ÿ“ฑ iOS, Android | ๐Ÿ”„ In Development

Complete WooCommerce mobile application

Purpose: WordPress WooCommerce integration

Key Features:

  • ๐Ÿช WooCommerce Integration: Full REST API integration
  • ๐Ÿ›’ E-commerce Features: Complete shopping experience
  • ๐Ÿ’ณ Payment Gateways: Multiple payment options
  • ๐Ÿ“ฆ Order Management: Complete order lifecycle
  • ๐Ÿ‘ค WordPress Auth: Seamless user authentication
  • ๐ŸŽจ Customizable: Brand-specific theming
  • ๐ŸŒ Multi-language: i18n support
๐Ÿ“– Storybook - Documentation hub | ๐ŸŒ Web | โœ… Production Ready

Component documentation and testing hub

Purpose: Component documentation and visual testing

Key Features:

  • ๐Ÿ“š Comprehensive Docs: Detailed component documentation
  • ๐ŸŽจ Visual Testing: Component state visualization
  • ๐Ÿ“‹ API Reference: Props and usage guidelines
  • ๐Ÿ” Search: Quick documentation access
  • ๐Ÿ’ก Examples: Real-world usage scenarios
  • ๐ŸŽจ Theme Preview: Test components in different themes

๐Ÿค Contributing & Community

๐Ÿ‘ฅ How to Contribute

We welcome contributions from the community! Here's how you can help:

  1. ๐Ÿด Fork the Repository

    git clone https://github.com/masterfabric-mobile/osmea.git
    cd osmea
  2. ๐ŸŒฟ Create a Feature Branch

    git checkout -b feature/amazing-feature
  3. ๐Ÿ’ป Make Your Changes

  4. ๐Ÿงช Test Your Changes

    flutter test
    flutter analyze
  5. ๐Ÿ“ Update Documentation

    • Add/update relevant documentation
    • Include code examples
    • Update CHANGELOG if applicable
  6. ๐Ÿš€ Submit a Pull Request

    • Use the PR template
    • Provide clear description
    • Link related issues
    • Request reviews

๐ŸŽฏ Current Opportunities

Check out our Issues for:

  • ๐Ÿ› Bug Fixes - Help improve stability and reliability
  • โœจ New Features - Add exciting functionality
  • ๐Ÿ“š Documentation - Improve guides and examples
  • ๐ŸŽจ UI Components - Create new components
  • ๐Ÿงช Testing - Increase test coverage
  • ๐ŸŒ Translations - Add language support
  • ๐Ÿ”ง Performance - Optimize existing code
  • โ™ฟ Accessibility - Improve accessibility features

๐ŸŒŸ Community Guidelines

๐Ÿ’ก Development Guidelines

  • Code Style: Follow Effective Dart guidelines
  • Testing: Write unit tests for business logic, widget tests for UI
  • Documentation: Document public APIs with clear examples
  • Commit Messages: Use Conventional Commits
  • Pull Requests: Keep PRs focused and reasonably sized

๐Ÿ† Recognition

Contributors are recognized in:

  • GitHub contributors page
  • Project documentation
  • Release notes
  • Community showcases

๐Ÿ“„ License & Legal

๐Ÿ” License: GNU Affero General Public License v3.0
๐Ÿ“œ This project is open source under AGPL v3.0 license.
If you use this project in production, you must open source your modifications.

๐Ÿ“Ž Legal Information


๐ŸŒŸ Community & Support

๐Ÿ“š Resources

๐Ÿ’ฌ Get Help

๐Ÿค Contributing

๐ŸŽฏ Built For

OSMEA is designed to serve a wide range of developers and use cases:

  • โœ… Startups - Build MVPs faster with pre-built components
  • โœ… Agencies - Manage multiple client storefronts efficiently
  • โœ… Enterprises - Scale with modular architecture
  • โœ… Freelancers - Deliver projects quickly with ready solutions
  • โœ… Open Source Contributors - Join and shape the ecosystem
  • โœ… Students & Learners - Learn e-commerce app development

๐ŸŒ Use Cases

๐Ÿ›’ E-commerce Applications

  • Mobile storefronts for Shopify and WooCommerce
  • Custom marketplace applications
  • B2B and B2C commerce platforms

๐Ÿ“ฑ Mobile Apps

  • Cross-platform iOS and Android applications
  • Progressive Web Apps (PWA)
  • Hybrid mobile solutions

๐ŸŒ Web Applications

  • Admin dashboards and management interfaces
  • API exploration and testing tools
  • Component documentation portals

๐Ÿ–ฅ๏ธ Desktop Applications

  • Store management tools
  • Internal business applications
  • Analytics and reporting dashboards

Experience all components in action with our interactive demo application.

Start building your e-commerce app today!


Built with โค๏ธ by the OSMEA Team

MasterFabric represents the architecture of e-commerce mobile apps.

ยฉ 2025 MasterFabric Mobile โ€ข Maintained by the OSMEA Engineering Team

๐ŸŒ Website โ€ข ๐Ÿ“š Documentation โ€ข ๐Ÿ› Issues โ€ข ๐Ÿ’ฌ Discussions

โฌ† Back to Top

About

MasterFabric represents the architecture of e-commerce mobile apps.Enterprise-level Flutter development.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors 14