StreamVybe - Music Streaming App

A Flutter music streaming application built with Clean Architecture and Provider state management.

🏗️ Architecture Overview

This project follows Clean Architecture principles, separating the codebase into three main layers:

1. Domain Layer (Business Logic)

• Entities: Plain Dart objects representing core business models
• Repositories: Abstract interfaces defining data operations
• Use Cases: Single-purpose classes containing business logic

2. Data Layer (Data Management)

• Data Sources: Remote (API) and Local (Cache) data sources
• Models: Data transfer objects with JSON serialization
• Repository Implementations: Concrete implementations of domain repositories

3. Presentation Layer (UI)

• Pages: Full-screen widgets representing app screens
• Widgets: Reusable UI components
• Providers: State management using Provider/ChangeNotifier

📁 Project Structure

lib/
├── core/                          # Core app functionality
│   ├── constants/                 # App-wide constants
│   │   ├── api_constants.dart
│   │   └── app_constants.dart
│   ├── di/                        # Dependency Injection
│   │   └── injection_container.dart
│   ├── errors/                    # Error handling
│   │   ├── exceptions.dart
│   │   └── failures.dart
│   ├── navigation/                # Routing
│   │   └── app_router.dart
│   ├── network/                   # Network layer
│   │   ├── api_client.dart
│   │   └── network_info.dart
│   ├── themes/                    # App themes
│   │   └── app_theme.dart
│   ├── usecases/                  # Base use case
│   │   └── usecase.dart
│   ├── utils/                     # Utility functions
│   │   ├── date_formatter.dart
│   │   ├── permission_helper.dart
│   │   └── validators.dart
│   └── widgets/                   # Shared widgets
│
├── features/                      # Feature modules
│   ├── auth/                      # Authentication feature
│   │   ├── data/
│   │   │   ├── datasources/
│   │   │   ├── models/
│   │   │   └── repositories/
│   │   ├── domain/
│   │   │   ├── entities/         # user.dart
│   │   │   ├── repositories/     # auth_repository.dart
│   │   │   └── usecases/         # login_usecase.dart
│   │   └── presentation/
│   │       ├── pages/
│   │       ├── providers/        # auth_provider.dart
│   │       └── widgets/
│   │
│   ├── onboarding/               # Onboarding feature
│   ├── home/                     # Home feature
│   ├── player/                   # Music player feature
│   ├── search/                   # Search feature
│   └── library/                  # Library feature
│
└── main.dart                     # App entry point

🎨 Design Principles

• Font: Manrope (official app font)
• Theme: Dark mode optimized for music streaming
• Responsive: Uses flutter_screenutil for responsive sizing
• Colors: Custom color palette inspired by modern music apps

📦 Key Dependencies

State Management

• provider - State management solution

Navigation

• go_router - Declarative routing

Audio

• just_audio - Audio playback
• audio_service - Background audio service
• audio_session - Audio session management

Network

• dio - HTTP client
• http - Additional HTTP support

Storage

• shared_preferences - Simple key-value storage
• flutter_secure_storage - Secure storage for tokens
• hive - NoSQL database

UI/UX

• flutter_screenutil - Responsive sizing
• google_fonts - Manrope font family
• cached_network_image - Image caching
• shimmer - Loading skeleton
• lottie - Animations

Utilities

• permission_handler - Runtime permissions
• connectivity_plus - Network connectivity
• path_provider - File system paths
• get_it - Dependency injection
• dartz - Functional programming
• equatable - Value equality
• logger - Logging

🔐 Permissions

Android

• Internet & Network access
• Storage (Read/Write)
• Audio & Media playback
• Foreground service
• Notifications
• Camera (for profile pictures)

iOS

• Camera access
• Photo library access
• Media library access
• Notifications
• Background audio playback

🚀 Getting Started

Prerequisites

• Flutter SDK (^3.10.4)
• Dart SDK
• Android Studio / Xcode

Installation

1. Clone the repository

   git clone <repository-url>
   cd streamvybe

2. Install dependencies

   flutter pub get

3. Run code generation (if needed)

   flutter pub run build_runner build --delete-conflicting-outputs

4. Run the app

   flutter run

🛠️ Development Workflow

Adding a New Feature

1. Create feature folder structure:

   lib/features/your_feature/
   ├── data/
   │   ├── datasources/
   │   ├── models/
   │   └── repositories/
   ├── domain/
   │   ├── entities/
   │   ├── repositories/
   │   └── usecases/
   └── presentation/
       ├── pages/
       ├── providers/
       └── widgets/
   

2. Domain Layer First:

   • Define entities
   • Create repository interface
   • Implement use cases

3. Data Layer:

   • Create data models
   • Implement data sources
   • Implement repository

4. Presentation Layer:

   • Create providers
   • Build UI pages
   • Create reusable widgets

5. Register in DI:

   • Add dependencies to injection_container.dart

State Management Pattern

This project uses Provider for state management:

// 1. Create Provider
class YourProvider with ChangeNotifier {
  // State and methods
  void updateState() {
    notifyListeners();
  }
}

// 2. Register in main.dart
MultiProvider(
  providers: [
    ChangeNotifierProvider(create: (_) => YourProvider()),
  ],
  child: YourApp(),
)

// 3. Use in UI
Consumer<YourProvider>(
  builder: (context, provider, child) {
    return YourWidget();
  },
)

🎯 Milestone 1 Checklist

• Flutter project setup with clean structure
• Package dependencies configured
• Environment setup (Android & iOS)
• Navigation setup (GoRouter)
• State management setup (Provider)
• Auth feature skeleton
• Onboarding structure
• API integration templates
• Error handling structure
• Permissions configuration
• Build auth screens (Login, Signup, Onboarding)
• Implement UI from Figma
• Wire up API services
• Test auth flow

📝 Next Steps

1. Implement Auth UI

   • Login page
   • Signup page
   • Forgot password page

2. Implement Onboarding

   • Create onboarding screens
   • Implement page indicators

3. Build Core Screens

   • Home page
   • Search page
   • Library page
   • Player page

4. API Integration

   • Implement data sources
   • Wire up repositories
   • Connect to backend

🤝 Contributing

1. Follow the clean architecture structure
2. Use Manrope font for all text
3. Maintain responsive design with ScreenUtil
4. Write meaningful commit messages
5. Test your changes thoroughly

📄 License

This project is private and confidential.

---

Built with ❤️ using Flutter and Clean Architecture