Skip to main content

​
Prerequisites

Before you begin, ensure you have the following installed on your system:

Flutter SDK

Version 3.3.0 or higher

Dart SDK

Comes bundled with Flutter

Git

For cloning the repository

Code Editor

VS Code or Android Studio recommended

​
Install Flutter SDK

If you haven’t installed Flutter yet, follow the official installation guide for your platform: Verify your Flutter installation: 
flutter doctor
This command checks your environment and displays a report of the status of your Flutter installation.

​
Clone the Repository

Clone the LarpLand repository to your local machine: 
git clone <repository-url>
cd larpland
The project uses the firebase branch for the backend. Make sure you’re on the correct branch after cloning.

​
Install Dependencies

Install all required Flutter packages defined in pubspec.yaml: 
flutter pub get

​
Key Dependencies

The project includes the following major dependencies: 
name: larpland
description: "A new Flutter project."
version: 1.0.0+1

environment:
  sdk: '>=3.3.0 <4.0.0'

dependencies:
  flutter:
    sdk: flutter
  
  # Firebase
  firebase_core: ^4.4.0
  firebase_auth: ^6.1.4
  cloud_firestore: ^6.1.2
  firebase_storage: ^13.0.6
  
  # HTTP & Networking
  http: ^1.2.1
  dio: ^5.4.3+1
  
  # State Management
  provider: ^6.1.2
  
  # UI Components
  cupertino_icons: ^1.0.6
  flutter_signin_button: ^2.0.0
  
  # Media & Storage
  image_picker: ^1.1.2
  path: ^1.9.1
  
  # Notifications
  flutter_local_notifications: ^20.1.0
  
  # Utilities
  async: ^2.11.0

dev_dependencies:
  flutter_test:
    sdk: flutter
  flutter_lints: ^6.0.0

​
Platform-Specific Setup

​
Android Setup

​
Minimum Requirements

  • minSdkVersion: As defined in Flutter’s configuration
  • targetSdkVersion: Latest version
  • Java 17: Required for compilation

​
Configure Gradle

The Android app configuration is located in android/app/build.gradle:
android/app/build.gradle
plugins {
    id "com.android.application"
    id "kotlin-android"
    id "dev.flutter.flutter-gradle-plugin"
    id "com.google.gms.google-services"  // Required for Firebase
}

android {
    namespace "com.example.larpland"
    compileSdk flutter.compileSdkVersion

    compileOptions {
        coreLibraryDesugaringEnabled true
        sourceCompatibility JavaVersion.VERSION_17
        targetCompatibility JavaVersion.VERSION_17
    }

    defaultConfig {
        applicationId "com.example.larpland"
        minSdkVersion flutter.minSdkVersion
        targetSdkVersion flutter.targetSdkVersion
        multiDexEnabled true  // Required for large apps
    }
}

dependencies {
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.1.5'
    implementation 'androidx.window:window:1.0.0'
    implementation 'androidx.window:window-java:1.0.0'
}

​
Run on Android

flutter run -d android
Or to build a release APK:
flutter build apk --release

​
Verify Installation

After completing the installation, verify everything is working:
1

Check Flutter Doctor

Run flutter doctor to ensure all dependencies are properly installed:
flutter doctor -v
2

Run Analyzer

Check for any code issues:
flutter analyze
3

Run Tests

Execute the test suite:
flutter test

​
Next Steps

Firebase Setup

Configure Firebase services for authentication, database, and storage

Quick Start

Get the app running in minutes with a quick setup guide

Build docs developers (and LLMs) love

Get started for freeTalk to us