Skip to content

Build and Contribute

Aryaroop Majumder edited this page Nov 5, 2026 · 1 revision

Build and Contribute

Build requirements

  • JDK 17
  • Android SDK Platform 36
  • Android Build Tools 35.0.0
  • A connected Android device or emulator only when you choose to run device tests

Clone the repository and set ANDROID_HOME or sdk.dir in the ignored local.properties file. Then run:

./gradlew :app:assembleDebug :app:testDebugUnitTest :app:lintDebug

For Android Auto development, use the Desktop Head Unit and follow the validation guide.

Contribute safely

  • Keep route geometry, Ferrostar maneuver data, ETA and rerouting independent of map themes.
  • Keep public screenshots and fixtures on fixed demonstration places. Never commit personal coordinates, routes, captures or device identifiers.
  • Do not add secrets, signing material, API keys or local APKs to Git.
  • Give each sourced font, image, audio file and dataset its own verified license and attribution record. A repository-level license does not automatically cover files at linked external locations.
  • Run the project checks before opening a pull request and describe the exact Android/device coverage you performed.

Read CONTRIBUTING.md, build and release details and validation results.

Clone this wiki locally