OSMEA ®️

Open Source Mobile E-commerce App Builder Tool

<div align="center">

</div> <div align="center"> <img src = "https://github.com/masterfabric-mobile/osmea/blob/OSMEA-Docs/docs/assets/osmea_banner_v2.png?raw=true" width="800" alt="OSMEA Banner">

"OSMEA is not just a framework — it's an ecosystem."

🚀 Live Demo • 📚 Documentation • 🔍 API Explorer • 🎮 Component Showcase

</div>

---

📋 Table of Contents

• 📊 Project Statistics
• 🌟 What is OSMEA?
  • 🎯 Our Mission
  • ⚡ Why Choose OSMEA?
• 🏗️ OSMEA Ecosystem Architecture
  • 📦 Core Packages
  • 🚀 Ready-to-Use Applications
  • 🛠️ Development Tools
• 🛠️ Technology Stack
  • Frontend & Mobile
  • Backend & APIs
  • E-commerce Platforms
  • Development & DevOps
• ✨ Key Features & Benefits
  • 🚀 Developer Experience
  • 🛒 E-commerce Features
  • 📱 Cross-Platform Excellence
• 🚀 Getting Started
  • 📋 Prerequisites
  • ⚡ Quick Start
  • 🎯 Choose Your Application
• 📚 Architecture & Documentation
  • 🏗️ Project Structure
  • 📖 Documentation Hub
  • 🧠 Architecture Principles
• 📦 Package Details
  • 🎨 OSMEA Components
  • 🔧 OSMEA Core
  • 🌐 OSMEA APIs
• 🚀 Application Showcase
• 🤝 Contributing & Community
  • 👥 How to Contribute
  • 🎯 Current Opportunities
  • 🌟 Community Guidelines
• 📄 License & Legal
  • 📎 Legal Information
  • ⚖️ Usage Guidelines
• 🌟 Community & Support

---

📊 Project Statistics

<div align="center">

| 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

</div>

---

🌟 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

• ⚙️ Automated Setup - One-command initialization script
• 📚 Comprehensive Docs - Guides, checklists, examples
• 🧪 Testing Framework - Unit, widget, integration tests
• 📋 Development Rules - Coding standards and guidelines
• 🔌 Plugin Documentation - Extension guides
• 📊 Version Logs - Release notes and history

---

🛠️ 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