Quick Start

Get MiyoList running locally in under 10 minutes

Prerequisites

  • Flutter SDK - Version 3.24.0 or higher Install Flutter →
  • Git - For cloning the repository
  • IDE - VS Code or Android Studio recommended

1. Clone the Repository

Fork and clone MiyoList to your local machine:

git clone https://github.com/YOUR_USERNAME/miyolist.git
cd miyolist

2. Install Dependencies

Get all required Flutter packages:

flutter pub get

3. Configure AniList OAuth

Before running the app, you need to register your own AniList API client:

  1. 1. Go to AniList Developer Settings
  2. 2. Click "Create New Client"
  3. 3. Fill in the form:
    Name: Your App Name
    Redirect URI:
    For web: https://yourdomain.com/auth/callback
    For mobile: yourapp://auth
    For desktop: http://localhost:8080/auth
  4. 4. Copy your Client ID

💡 Pro Tip: You can use MiyoList's web OAuth gateway at https://miyo.my/auth/login to simplify authentication across platforms. See OAuth Setup for details.

4. Update Configuration

Update your Client ID in the app constants:

lib/core/constants/app_constants.dart

class AppConstants {
  // Replace with your AniList Client ID
  static const String clientId = 'YOUR_CLIENT_ID';
  
  // Use web OAuth gateway (recommended)
  static const String redirectUri = 'https://miyo.my/auth/callback';
  
  // Or use platform-specific URIs
  // static const String redirectUri = 'yourapp://auth'; // Mobile
  // static const String redirectUri = 'http://localhost:8080/auth'; // Desktop
}

5. Run the App

Choose your target platform and run:

🪟 Windows

flutter run -d windows

🤖 Android

flutter run -d android

Make sure you have an Android device connected or emulator running

🌐 Web (Development)

flutter run -d chrome

Note: Web version is experimental

6. Build for Production

When ready to create a release build:

Windows EXE

flutter build windows --release

Output: build/windows/x64/runner/Release/

Android APK

flutter build apk --release

Output: build/app/outputs/flutter-apk/app-release.apk