This guide helps you get Chirp running on your machine with the correct toolchain and IDE configuration.
- JDK: Java 17 (ensure your IDE and Gradle toolchain use JDK 17)
- Gradle: Use the wrapper included in the repository
- Windows:
./gradlew.bat - macOS/Linux:
./gradlew
- Windows:
- Android Studio with Android SDK Platform 36 and matching build tools
- Xcode (macOS only) for building/running iOS
- Clone the repository.
- Open in Android Studio (recommended) or IntelliJ IDEA with KMP support.
- Let Gradle sync and download dependencies.
Notes:
- On non‑macOS machines, iOS Kotlin/Native targets will be disabled during configuration. This is expected and harmless for Android/Desktop work.
local.propertiesis managed by Android Studio; do not commit secrets.
Windows examples:
- Clean + build all:
./gradlew.bat clean build - List tasks for a module:
./gradlew.bat :composeApp:tasks
- Ensure SDK Platform 36 and required build tools are installed in Android Studio.
- Debug APK:
./gradlew.bat :composeApp:assembleDebug - Install on device/emulator:
./gradlew.bat :composeApp:installDebug
- Open
iosAppin Xcode and run on Simulator or device. - Frameworks are produced from
composeAppiOS targets.
- Run:
./gradlew.bat :composeApp:run - Package distribution (current OS):
./gradlew.bat :composeApp:packageDistributionForCurrentOS
Some modules apply a BuildKonfig convention requiring an API_KEY in local.properties at the repo
root:
API_KEY=your_value_here
If missing, the build will fail for those modules. See docs/architecture.md for details.