Skip to content

K09-0/MEE

Repository files navigation

MEE - MicroExperiential Engine

MEE Logo

AI-powered micro-experience marketplace for Gen Z

Features โ€ข Tech Stack โ€ข Architecture โ€ข Getting Started โ€ข Deployment


๐Ÿš€ Features

Core Features

  • ๐Ÿ” Authentication - Email/Password, Google Sign-In, Apple Sign-In
  • ๐ŸŽจ AI Creator Studio - Generate images, music, text, and mini-games
  • ๐Ÿ›’ Marketplace - Browse, filter, and purchase micro-experiences
  • ๐Ÿ’ฐ Wallet - Track earnings, withdrawals, and transaction history
  • ๐Ÿ”— Viral Mechanics - Referral system, deep links, social sharing
  • โฐ FOMO Timers - Time-limited exclusive content

Experience Types

Type Description Price Range
๐ŸŽจ Digital Art AI-generated artwork $0.99 - $4.99
๐ŸŽต Music AI-composed tracks $0.99 - $2.99
๐ŸŽฎ Mini-Games Interactive experiences $1.99 - $4.99
๐Ÿ“– Stories AI-generated narratives $0.99 - $1.99

๐Ÿ›  Tech Stack

Frontend

  • Flutter 3.x - Cross-platform UI framework
  • Dart 3.x - Programming language
  • BLoC Pattern - State management
  • Material 3 - Design system

Backend

  • Firebase Auth - Authentication
  • Cloud Firestore - NoSQL database
  • Firebase Storage - File storage
  • Cloud Functions - Serverless functions
  • Firebase Dynamic Links - Deep linking

AI Integration

  • Hugging Face - Text generation, image models
  • Replicate - Advanced AI models
  • Stability AI - Image generation

Payments

  • Stripe - Credit/debit card payments
  • Solana Pay - Cryptocurrency payments
  • TON Connect - TON blockchain payments

๐Ÿ— Architecture

Clean Architecture

lib/
โ”œโ”€โ”€ core/                    # Core utilities
โ”‚   โ”œโ”€โ”€ errors/             # Exceptions and failures
โ”‚   โ”œโ”€โ”€ theme/              # App theme and colors
โ”‚   โ””โ”€โ”€ utils/              # Helper functions
โ”œโ”€โ”€ data/                    # Data layer
โ”‚   โ”œโ”€โ”€ models/             # Data models
โ”‚   โ””โ”€โ”€ repositories/       # Repository implementations
โ”œโ”€โ”€ domain/                  # Domain layer
โ”‚   โ”œโ”€โ”€ entities/           # Business entities
โ”‚   โ”œโ”€โ”€ repositories/       # Repository interfaces
โ”‚   โ””โ”€โ”€ usecases/           # Business logic
โ”œโ”€โ”€ features/                # Feature modules
โ”‚   โ”œโ”€โ”€ auth/               # Authentication
โ”‚   โ”œโ”€โ”€ creator/            # AI Creator Studio
โ”‚   โ”œโ”€โ”€ marketplace/        # Browse & Purchase
โ”‚   โ”œโ”€โ”€ wallet/             # Payments & Earnings
โ”‚   โ””โ”€โ”€ profile/            # User profile
โ””โ”€โ”€ services/               # External services
    โ”œโ”€โ”€ ai_service.dart     # AI generation
    โ””โ”€โ”€ payment_service.dart # Payment processing

State Management

UI โ†’ BLoC โ†’ Repository โ†’ Data Source
         โ†“
    State Stream โ†’ UI Update

๐Ÿ“ฆ Getting Started

Prerequisites

  • Flutter SDK >= 3.0.0
  • Dart SDK >= 3.0.0
  • Firebase CLI
  • Android Studio / Xcode

Installation

  1. Clone the repository
git clone https://github.com/yourusername/mee-app.git
cd mee-app
  1. Install dependencies
flutter pub get
  1. Configure Firebase
# Install FlutterFire CLI
dart pub global activate flutterfire_cli

# Configure Firebase
flutterfire configure
  1. Set up environment variables
cp .env.example .env.development
# Edit .env.development with your API keys
  1. Run the app
flutter run

๐Ÿงช Testing

# Run unit tests
flutter test

# Run with coverage
flutter test --coverage

# Run integration tests
flutter test integration_test/

๐Ÿš€ Deployment

See DEPLOYMENT_GUIDE.md for detailed deployment instructions.

Quick Deploy

# iOS
flutter build ipa --release

# Android
flutter build appbundle --release

๐Ÿ“Š Business Model

Revenue Split

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚         Purchase: $1.99             โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚  Creator: 80%      โ”‚   $1.59        โ”‚
โ”‚  Platform: 20%     โ”‚   $0.40        โ”‚
โ”‚  Referral: 10%*    โ”‚   $0.20        โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
* When referral code is used

Key Metrics

  • Target Audience: Gen Z (18-25)
  • Price Range: $0.99 - $4.99
  • Creator Earnings: 70-80%
  • Platform Fee: 20%
  • Referral Bonus: 10%

๐ŸŽจ Design System

Colors

Name Hex Usage
Primary #7B2FF7 Buttons, accents
Secondary #00D4AA Success, highlights
Background #0A0A0F Main background
Surface #141419 Cards, inputs
Error #FF4D4D Errors, warnings

Typography

  • Display: Inter Bold
  • Headline: Inter SemiBold
  • Body: Inter Regular
  • Caption: Inter Medium

๐Ÿ” Security

  • โœ… Firebase Authentication with secure tokens
  • โœ… Firestore Security Rules
  • โœ… Input validation and sanitization
  • โœ… Rate limiting on API calls
  • โœ… Secure payment processing
  • โœ… Data encryption at rest

๐Ÿ“ฑ Screenshots

Feed Creator Studio Wallet Profile


๐Ÿค Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Code Style

  • Follow Effective Dart
  • Use dart format before committing
  • Run flutter analyze to check for issues

๐Ÿ“„ License

This project is licensed under the MIT License - see LICENSE file for details.


๐Ÿ™ Acknowledgments


๐Ÿ“ž Contact


Made with ๐Ÿ’œ by the MEE Team

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages