Installation Guide

Complete setup guide to get MiyoList running on your machine

📋 Prerequisites

Before you begin, make sure you have the following installed:

  • Flutter SDK (3.5.0 or higher) Download Flutter
  • Dart SDK (included with Flutter)
  • Git for version control Download Git
  • Visual Studio Code or Android Studio (recommended)
  • Platform-specific tools:
    • • Windows: Visual Studio 2022 with Desktop development
    • • macOS: Xcode (for iOS/macOS builds)
    • • Linux: GTK development libraries
    • • Android: Android SDK & NDK

1️⃣ Clone the Repository

Clone the MiyoList repository from GitHub:

git clone https://github.com/Baconana-chan/miyolist.git
cd miyolist

2️⃣ Install Dependencies

Install all required Flutter packages:

flutter pub get

This will download and install all dependencies listed in pubspec.yaml

3️⃣ Configure Environment

Create environment configuration files:

AniList API Configuration

Create lib/core/config/api_config.dart:

class ApiConfig {
  // Your AniList Client ID
  static const String clientId = 'YOUR_CLIENT_ID';
  
  // OAuth Redirect URI
  static const String redirectUri = 'https://miyo.my/auth/callback';
  
  // For local development (optional)
  static const String devRedirectUri = 'http://localhost:4321/auth/callback';
}

Supabase Configuration (Optional)

If you're using Supabase for cloud sync, create lib/core/config/supabase_config.dart:

class SupabaseConfig {
  static const String url = 'YOUR_SUPABASE_URL';
  static const String anonKey = 'YOUR_SUPABASE_ANON_KEY';
}

💡 Note: You'll need to create your own AniList API application at anilist.co/settings/developer to get your Client ID.

4️⃣ Run the Application

Check available devices:

flutter devices

Run the app on your desired platform:

Windows:

flutter run -d windows

Android:

flutter run -d android

macOS:

flutter run -d macos

iOS:

flutter run -d ios

5️⃣ Build for Production

Create a production build for distribution:

Windows (MSIX):

flutter build windows --release

Android (APK):

flutter build apk --release

Android (App Bundle for Play Store):

flutter build appbundle --release

macOS:

flutter build macos --release

iOS:

flutter build ios --release

⚠️ Important: For iOS and macOS builds, you'll need an Apple Developer account and proper code signing certificates.

🔧 Troubleshooting

Common Issues:

❌ "pub get failed"

Solution: Clean and reinstall dependencies

flutter clean
flutter pub get

❌ Build fails with "target not found"

Solution: Verify Flutter doctor

flutter doctor -v

Fix any issues reported by Flutter doctor

❌ "No devices found"

Solution: Enable platform support

flutter config --enable-windows-desktop
flutter config --enable-macos-desktop
flutter config --enable-linux-desktop

❌ OAuth redirect not working

Solution: Check your AniList app settings

  • • Verify redirect URI matches exactly
  • • Check for typos in Client ID
  • • Ensure your app is not in development mode

🎯 Next Steps