Setup

Development Setup Guide

Follow these steps to set up your environment and run Underseerr.

Prerequisites

1. JDK 24+: Underseerr uses modern Java features. We recommend using sdkman to manage your SDKs.
2. Android Studio (Ladybug+): Required for Compose Multiplatform support.
3. Firebase Project: Required for push notifications and analytics.

Cloning the Repository

git clone https://github.com/lusky3/underseerr.git
cd underseerr

Configuration

1. SDK Management

If you have sdkman installed, the project includes a .sdkmanrc file. Simply run:

sdk install java $(cat .sdkmanrc | cut -d'=' -f2)

2. Firebase (google-services.json)

You need a google-services.json file to compile the Android app.

• Place your debug file in: androidApp/src/debug/google-services.json
• Place your release file in: androidApp/src/release/google-services.json

Building and Running

Command Line

# Run unit tests
./gradlew testDebugUnitTest

# Assemble Debug APK
./gradlew :androidApp:assembleDebug

Android Studio

1. Open the project and wait for Gradle sync.
2. Select the androidApp run configuration and click Run.

Common Issues

If you encounter build errors, please check the Troubleshooting Guide.