Skip to main content

APP Quick Start

Prerequisites

  • Flutter 3.32.4 • channel stable • https://github.com/flutter/flutter.git Framework • revision 6fba2447e9 • 2025-06-12 19:03:56 -0700 Engine • revision 8cd19e509d • 2025-06-12 16:30:12 -0700 Tools • Dart 3.8.1 • DevTools 2.45.1 (Flutter 3.32.*) Please refer to the official Flutter documentation: Set up your Flutter development environment(https://docs.flutter.dev/get-started/install)
  • Android Studio / Xcode

Installation

# Clone repository
git clone https://github.com/Buddie-AI/Buddie.git
cd Buddie/APP

# Install dependencies
flutter pub get

# Release an Android apk
flutter build apk --release
For detailed documentation, refer to the Flutter official documentation for building Android apps.(https://docs.flutter.dev/deployment/android)

# Release an ios apk
flutter build ipa
Building and releasing an iOS app requires Xcode, so you must have a computer running macOS.
An Apple Developer account is also required.
For detailed documentation, refer to the Flutter official guide for building iOS apps.(https://docs.flutter.dev/deployment/ios)

# Launch on Android or an Android emulator
flutter run

📖 User Guide

  1. The app will guide you through 30-second voiceprint registration when first launched.
  2. For enhanced voice features with Buddie headphones:
  • Open Settings in app
  • Select "Connect"
  • Ensure earphones are already paired in the system
  • Confirm connection in app

🛠️ Tech Stack

  • Frontend Framework: Flutter
  • State Management: Provider
  • Database: ObjectBox