magic_mouse

Comprehensive instructions for running and building the Magic Mouse Flutter app.

Contents

• Prerequisites: software and SDKs required to run the app
• Install: how to fetch dependencies
• Run (dev): commands to run on Android, iOS, Web and Desktop
• Build (release): how to produce distributable binaries
• Backend: how to run the included server component (if needed)
• Troubleshooting: common issues and quick fixes

---

Prerequisites

• Flutter SDK (stable). Install from https://flutter.dev and ensure flutter is on your PATH.
• Android SDK / Android Studio for Android targets (set ANDROID_HOME/ANDROID_SDK_ROOT).
• Xcode (macOS) for iOS builds and simulator testing.
• A connected device or emulator/simulator for the target platform.
• Python 3.8+ and pip for the optional backend server in /server.

Verify your environment with:

flutter doctor -v

---

Install

From the project root (this repository contains the Flutter project in the magic_mouse folder):

cd magic_mouse
flutter pub get

This will download Dart/Flutter packages listed in pubspec.yaml.

---

Run (development)

Android (device or emulator):

flutter run -d <device-id>

To list devices use flutter devices.

iOS (macOS with Xcode):

flutter run -d <device-id-or-simulator>

Web (Chrome):

flutter run -d chrome

Windows / Linux / macOS desktop (if enabled in pubspec and tools):

flutter run -d windows
flutter run -d linux
flutter run -d macos

Use --flavor or additional --dart-define flags as needed for environment-specific config.

---

Build (release)

Android APK (debug / release):

flutter build apk --release

Android app bundle (recommended for Play Store):

flutter build appbundle --release

iOS (macOS, requires signing set up in Xcode):

flutter build ios --release

Web (release build):

flutter build web --release

Desktop (example for Windows):

flutter build windows --release

The built artifacts will be in build/ under the project directory.

---

Backend server (optional)

This repository contains a lightweight backend in /server used for local testing.

To run it (recommended inside a virtual environment):

Windows PowerShell:

cd server
python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -r requirements.txt
python server.py

Or use the provided start_server.bat on Windows:

.\start_server.bat

By default the server listens on the port printed in its startup logs — update the Flutter app base URL if necessary.

---

Troubleshooting

• If flutter run fails with an Android licensing or SDK error, open Android Studio and install the required SDK components.
• For iOS build-signing issues, open the Xcode workspace at ios/Runner.xcworkspace and configure signing in the Targets pane.
• If packages fail to resolve, remove pubspec.lock and re-run flutter pub get.
• If hot reload doesn't pick changes, try r in the running flutter run session or restart the app.

---

Useful files

• Project entry: lib/main.dart
• Flutter manifest: pubspec.yaml
• Android build config: android/app/build.gradle.kts
• iOS project: ios/Runner.xcodeproj and ios/Runner.xcworkspace
• Local backend: server/server.py and server/requirements.txt

---

If you'd like, I can also:

• Add a top-level README summarizing the repo, or
• Create platform-specific run scripts (Windows batch / macOS shell) for convenience.

Happy to do the next step you prefer.