mirror of
https://github.com/Dvorinka/swingmusic-extended.git
synced 2026-06-03 20:13:02 +00:00
Remove Android submodule and update to mobile-only structure
This commit is contained in:
Tomas Dvorak
@@ -0,0 +1,355 @@
|
||||
# 🎵 SwingMusic Mobile Development Plan
|
||||
|
||||
## 📱 Current Status
|
||||
|
||||
### ✅ Completed
|
||||
- **Desktop App**: Cross-platform (Linux, Windows, macOS) - Tauri + Rust
|
||||
- **Android App**: Native Kotlin implementation
|
||||
- **Backend**: Python REST API server
|
||||
- **Web Client**: Vue.js frontend
|
||||
- **CI/CD**: Unified release system with semantic versioning
|
||||
- **Fully convert the current android app app to the unified flutter app - but keep the original folder as a reference and backup dont remove it or edit anything in it, only create in the new one**
|
||||
|
||||
### 🎯 Target
|
||||
- **iOS App**: Flutter cross-platform implementation
|
||||
- **Unified Mobile**: Single codebase for iOS + Android
|
||||
|
||||
## 🚀 Flutter Implementation Plan
|
||||
|
||||
### Phase 1: Project Setup & Foundation (Week 1-2)
|
||||
|
||||
#### 📁 Repository Structure
|
||||
```
|
||||
swingmusic-mobile/
|
||||
├── lib/
|
||||
│ ├── core/
|
||||
│ │ ├── constants/
|
||||
│ │ ├── themes/
|
||||
│ │ ├── utils/
|
||||
│ │ └── widgets/
|
||||
│ ├── data/
|
||||
│ │ ├── models/
|
||||
│ │ ├── repositories/
|
||||
│ │ └── services/
|
||||
│ ├── features/
|
||||
│ │ ├── auth/
|
||||
│ │ ├── library/
|
||||
│ │ ├── player/
|
||||
│ │ ├── search/
|
||||
│ │ ├── playlists/
|
||||
│ │ ├── offline/
|
||||
│ │ └── analytics/
|
||||
│ └── shared/
|
||||
│ ├── providers/
|
||||
│ └── routes/
|
||||
├── assets/
|
||||
│ ├── images/
|
||||
│ ├── fonts/
|
||||
│ └── audio/
|
||||
├── test/
|
||||
├── integration_test/
|
||||
└── ios/
|
||||
└── android/
|
||||
```
|
||||
|
||||
#### 🔧 Technical Setup
|
||||
- [ ] Create `swingmusic-mobile` Flutter submodule
|
||||
- [ ] Set up project dependencies
|
||||
- [ ] Configure state management (Provider/Bloc)
|
||||
- [ ] Set up navigation (go_router)
|
||||
- [ ] Implement theming system (Material Design 3)
|
||||
- [ ] Set up API client integration
|
||||
- [ ] Configure audio services (just_audio)
|
||||
|
||||
#### 📦 Core Dependencies
|
||||
```yaml
|
||||
dependencies:
|
||||
flutter:
|
||||
sdk: flutter
|
||||
|
||||
# State Management
|
||||
provider: ^6.1.1
|
||||
# or bloc: ^8.1.3
|
||||
|
||||
# Navigation
|
||||
go_router: ^12.1.3
|
||||
|
||||
# Audio
|
||||
just_audio: ^0.9.36
|
||||
audio_session: ^0.1.16
|
||||
|
||||
# UI & Animations
|
||||
flutter_staggered_animations: ^1.1.1
|
||||
lottie: ^2.7.0
|
||||
|
||||
# Network & API
|
||||
dio: ^5.3.2
|
||||
retrofit: ^4.0.3
|
||||
|
||||
# Local Storage
|
||||
hive: ^2.2.3
|
||||
hive_flutter: ^1.1.0
|
||||
path_provider: ^2.1.1
|
||||
|
||||
# Media & Metadata
|
||||
audio_metadata: ^4.2.0
|
||||
|
||||
# Visualizations
|
||||
flutter_audio_waveforms: ^1.2.0
|
||||
|
||||
# Permissions
|
||||
permission_handler: ^11.0.1
|
||||
|
||||
# Background Processing
|
||||
workmanager: ^0.5.2
|
||||
```
|
||||
|
||||
### Phase 2: Core Features (Week 3-4)
|
||||
|
||||
#### 🎵 Audio Engine
|
||||
- [ ] Implement audio playback service
|
||||
- [ ] Background playback support
|
||||
- [ ] Audio focus management
|
||||
- [ ] Media session integration
|
||||
- [ ] Equalizer support
|
||||
|
||||
#### 📚 Library Management
|
||||
- [ ] API integration for music library
|
||||
- [ ] Local caching with Hive
|
||||
- [ ] Lazy loading for large libraries
|
||||
- [ ] Search functionality
|
||||
- [ ] Metadata extraction
|
||||
|
||||
#### 🎨 Core UI Components
|
||||
- [ ] Material Design 3 theme system
|
||||
- [ ] Custom audio player widget
|
||||
- [ ] Track list components
|
||||
- [ ] Album/artist cards
|
||||
- [ ] Search interface
|
||||
|
||||
### Phase 3: Advanced Features (Week 5-6)
|
||||
|
||||
#### 🌊 Visualizations & UI
|
||||
- [ ] Waveform visualization
|
||||
- [ ] Audio spectrum analyzer
|
||||
- [ ] Smooth animations
|
||||
- [ ] Gesture controls
|
||||
- [ ] Responsive layouts
|
||||
|
||||
#### 💾 Offline Mode
|
||||
- [ ] Download management
|
||||
- [ ] Local storage optimization
|
||||
- [ ] Offline playback
|
||||
- [ ] Sync with server
|
||||
- [ ] Storage management
|
||||
|
||||
#### 🎤 Lyrics & Metadata
|
||||
- [ ] Real-time lyrics sync
|
||||
- [ ] Lyrics display UI
|
||||
- [ ] Album artwork handling
|
||||
- [ ] Metadata editing
|
||||
- [ ] Tag reading
|
||||
|
||||
### Phase 4: Enhanced Features (Week 7-8)
|
||||
|
||||
#### 📊 Analytics & Insights
|
||||
- [ ] Listening statistics
|
||||
- [ ] Play history tracking
|
||||
- [ ] Favorite tracks/artists
|
||||
- [ ] Usage analytics dashboard
|
||||
- [ ] Year-end recap
|
||||
|
||||
#### 🎯 User Experience
|
||||
- [ ] Home screen widgets
|
||||
- [ ] Notification controls
|
||||
- [ ] Lock screen integration
|
||||
- [ ] Car mode support
|
||||
- [ ] Accessibility features
|
||||
|
||||
#### 🔗 Integration
|
||||
- [ ] Backend API integration
|
||||
- [ ] Authentication system
|
||||
- [ ] Playlist synchronization
|
||||
- [ ] Social features
|
||||
- [ ] Sharing capabilities
|
||||
|
||||
### Phase 5: Testing & Polish (Week 9-10)
|
||||
|
||||
#### 🧪 Quality Assurance
|
||||
- [ ] Unit tests (90%+ coverage)
|
||||
- [ ] Integration tests
|
||||
- [ ] Widget tests
|
||||
- [ ] Performance testing
|
||||
- [ ] Memory leak testing
|
||||
|
||||
#### 🐛 Bug Fixes & Optimization
|
||||
- [ ] Performance optimization
|
||||
- [ ] Battery usage optimization
|
||||
- [ ] Memory management
|
||||
- [ ] Error handling
|
||||
- [ ] Edge case coverage
|
||||
|
||||
#### 📱 Platform-Specific Features
|
||||
- [ ] iOS-specific optimizations
|
||||
- [ ] Android-specific features
|
||||
- [ ] Platform integration
|
||||
- [ ] App store preparation
|
||||
- [ ] Signing and distribution
|
||||
|
||||
## 🔧 Technical Architecture
|
||||
|
||||
### 🏗️ State Management
|
||||
**Provider Pattern** (Recommended for simplicity)
|
||||
```dart
|
||||
// Audio provider for global state
|
||||
class AudioProvider extends ChangeNotifier {
|
||||
AudioPlayer _player;
|
||||
TrackModel? _currentTrack;
|
||||
bool _isPlaying = false;
|
||||
|
||||
// Audio controls, state management
|
||||
}
|
||||
|
||||
// Library provider for data
|
||||
class LibraryProvider extends ChangeNotifier {
|
||||
List<TrackModel> _tracks;
|
||||
List<AlbumModel> _albums;
|
||||
List<ArtistModel> _artists;
|
||||
|
||||
// Library management
|
||||
}
|
||||
```
|
||||
|
||||
### 🌐 API Integration
|
||||
```dart
|
||||
// Retrofit for type-safe API
|
||||
@RestApi(baseUrl: 'https://your-api.com')
|
||||
abstract class MusicApiService {
|
||||
@GET('/tracks')
|
||||
Future<List<TrackModel>> getTracks();
|
||||
|
||||
@GET('/albums')
|
||||
Future<List<AlbumModel>> getAlbums();
|
||||
|
||||
@POST('/playlists')
|
||||
Future<PlaylistModel> createPlaylist(@Body() PlaylistModel playlist);
|
||||
}
|
||||
```
|
||||
|
||||
### 💾 Local Storage
|
||||
```dart
|
||||
// Hive for local caching
|
||||
class TrackAdapter extends TypeAdapter<TrackModel> {
|
||||
@override
|
||||
TrackModel read(BinaryReader reader) {
|
||||
// Deserialization
|
||||
}
|
||||
|
||||
@override
|
||||
void write(BinaryWriter writer, TrackModel obj) {
|
||||
// Serialization
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 📋 CI/CD Integration
|
||||
|
||||
### 🔄 Build Pipeline Updates
|
||||
```yaml
|
||||
# Add to unified-release.yml
|
||||
build-flutter-mobile:
|
||||
name: Build Flutter Mobile Apps
|
||||
runs-on: ubuntu-latest
|
||||
needs: get-version
|
||||
if: contains(github.event.inputs.components, 'mobile') || github.event_name == 'push'
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
- platform: 'android-arm64'
|
||||
os: ubuntu-latest
|
||||
target: 'android-arm64'
|
||||
- platform: 'android-x64'
|
||||
os: ubuntu-latest
|
||||
target: 'android-x64'
|
||||
- platform: 'ios-arm64'
|
||||
os: macos-latest
|
||||
target: 'ios-arm64'
|
||||
- platform: 'ios-x64'
|
||||
os: macos-latest
|
||||
target: 'ios-x64'
|
||||
```
|
||||
|
||||
### 📦 Distribution
|
||||
- **Android**: APK + AAB for Google Play
|
||||
- **iOS**: IPA for App Store
|
||||
- **Testing**: Firebase App Distribution
|
||||
- **Beta**: TestFlight for iOS
|
||||
|
||||
## 🎯 Success Metrics
|
||||
|
||||
### 📈 Technical Goals
|
||||
- [ ] 60 FPS smooth animations
|
||||
- [ ] < 100ms audio response time
|
||||
- [ ] < 50MB app size
|
||||
- [ ] 4+ hour battery life for continuous playback
|
||||
- [ ] 10,000+ track library support
|
||||
|
||||
### 🎨 User Experience Goals
|
||||
- [ ] < 3 seconds app startup time
|
||||
- [ ] Intuitive navigation (≤ 3 taps to any feature)
|
||||
- [ ] Beautiful Material Design 3 interface
|
||||
- [ ] Accessibility compliance (WCAG 2.1 AA)
|
||||
- [ ] Multi-language support
|
||||
|
||||
### 🔧 Development Goals
|
||||
- [ ] 90%+ test coverage
|
||||
- [ ] < 1 week release cycle
|
||||
- [ ] Zero critical bugs in production
|
||||
- [ ] Consistent code quality (A+ grade)
|
||||
- [ ] Comprehensive documentation
|
||||
|
||||
## 🚀 Migration Strategy
|
||||
|
||||
### 📱 Transition Plan
|
||||
1. **Parallel Development**: Flutter alongside Android native
|
||||
2. **Feature Parity**: Match all Android features
|
||||
3. **Beta Testing**: Internal testing with Flutter app
|
||||
4. **Public Beta**: Release Flutter version for testing
|
||||
5. **Phase-out**: Deprecate Android native app
|
||||
6. **Full Migration**: Complete switch to Flutter
|
||||
|
||||
### 🔄 Data Migration
|
||||
- User preferences and settings
|
||||
- Offline downloaded content
|
||||
- Playlists and favorites
|
||||
- Listening history and statistics
|
||||
|
||||
## 📅 Timeline
|
||||
|
||||
| Phase | Duration | Key Deliverables |
|
||||
|-------|----------|------------------|
|
||||
| Phase 1 | 2 weeks | Project setup, foundation |
|
||||
| Phase 2 | 2 weeks | Core features, basic app |
|
||||
| Phase 3 | 2 weeks | Advanced features |
|
||||
| Phase 4 | 2 weeks | Enhanced features |
|
||||
| Phase 5 | 2 weeks | Testing, polish |
|
||||
| **Total** | **10 weeks** | **Production-ready Flutter app** |
|
||||
|
||||
## 🎯 Next Steps
|
||||
|
||||
### Immediate Actions
|
||||
1. **Review and approve** this plan
|
||||
2. **Create Flutter submodule** structure
|
||||
3. **Set up development environment**
|
||||
4. **Begin Phase 1 implementation**
|
||||
|
||||
### Long-term Vision
|
||||
- **Unified mobile experience** across iOS and Android
|
||||
- **Seamless integration** with existing SwingMusic ecosystem
|
||||
- **Modern, performant** mobile application
|
||||
- **Cross-platform consistency** with desktop and web
|
||||
|
||||
---
|
||||
|
||||
*This plan provides a comprehensive roadmap for developing a high-quality Flutter mobile application that integrates seamlessly with the existing SwingMusic ecosystem while delivering an exceptional user experience on both iOS and Android platforms.*
|
||||
Reference in New Issue
Block a user