How thekoon0456/lilsmusic works
Project type and purpose
• LilsMusic is an iOS client application (UIKit-based) for streaming and managing music and music videos.
• It follows a MVVM-Coordinator (MVVM-C) architecture, employs a Repository layer for data persistence (Realm) and remote calls (MusicKit, Apple Music API), uses RxSwift/SwiftConcurrency for async flows, and has a WidgetKit extension.
File structure and map to architectural layers
• App: AppDelegate, SceneDelegate → application entry point, scene lifecycle, initial coordinator.
• Presenter: split by “Scene” modules (Launch, Library, MusicList, MusicPlayer, MusicRecommend, Reels)
– Each Scene folder contains:
· Coordinator → handles navigation flows
· ViewController (in “View”) → UIKit screens
· ViewModel (in “ViewModel”) → business logic, exposes Input/Output streams
· Cell/View subfolders → reusable UI components
• Data:
– Model → domain entities (UserLibrary, UserSetting…)
– Repository → protocols + implementations (MusicAPIManager, UserPlaylistRepository)
• Manager: singletons handling cross-cutting concerns (FMMusicPlayer, SubscriptionManager, UserDefaultsManager)
• CommonUI/Base: shared UI controls and base classes for views, cells, view controllers
• Protocol: definition of Coordinator, Repository, ViewModel interfaces
• Resources: asset catalog, storyboards, Info.plist
• LilsMusicWidget: WidgetKit extension for home-screen widget
README for technology stack & key interactions
• MVVM-C with Input/Output binding (RxSwift + async/await)
• MusicKit, AVFoundation/AVKit for playback & streaming
• Realm for local caching and real-time updates to UI via notification tokens
• Firebase for analytics/crash reporting
• Kingfisher for image loading
• SnapKit for layout
• Compositional Layout for complex collection view layouts
1. Mobile Client (iOS App)
• UI Layer
– Views / ViewControllers
– Coordinators
• Presentation Layer
– ViewModels (RxSwift / SwiftConcurrency bindings)
• Business Logic Layer
– Managers (Player, Subscription, Settings)
– Repositories (protocols + implementations)
• Data Layer
– Local Database (Realm)
– Remote API (MusicKit / Apple Music API via MusicAPIManager)
2. Widget Extension (LilsMusicWidget)
• WidgetKit entry point → fetches data via Repository / Manager
3. External Services
• Apple Music service (catalog, playback entitlement)
• Firebase (Analytics, Crashlytics)
• Asset CDN (Kingfisher image URLs)
Relationships & data flows
• User taps UI → ViewController sends event to ViewModel Input
• ViewModel processes, calls Repository or Manager (via protocol)
• Repository delegates to:
– MusicAPIManager → MusicKit / Apple Music API → network → returns songs/playlists
– Realm Repository → local cache updates → emits notifications → ViewModel observes & publishes to Output
• ViewModel Output → bound to ViewController UI elements via RxSwift / Combine or async/await bridges
• Coordinator listens to ViewModel to trigger navigation (present player, subscription offer)
• Player Manager wraps AVQueuePlayer / AVPlayer → streams audio/video → updates current track → publishes via BehaviorSubject → ViewModel → UI
• WidgetKit uses the same Repository layer or direct Manager calls to fetch snapshot data
Architectural patterns & design principles
• MVVM-C: clear separation of UI, presentation, business logic, and navigation
• Repository Pattern: abstracts data sources, enforces protocol contracts
• Singleton Managers for cross-cutting concerns (player, subscription, user defaults)
• Input/Output binding ensures unidirectional data flow, testability
• Code-based UI + Compositional Layout for dynamic collection views
• Reactive Streams (RxSwift) + SwiftConcurrency for unified async behavior
Elements
• Clear labels for modules: e.g., “MusicListScene Coordinator”, “MusicListViewModel”, “MusicListViewController”
– Event flow (UI → VM_Input)
– Data flow (VM → Repo → API/DB → VM_Output → UI)
– Navigation flow (VM → Coordinator → UI)
– Playback flow (Player Manager → AVPlayer → streaming source)
• Notes on side for major frameworks: RxSwift, SwiftConcurrency, MusicKit, Realm, Firebase