- Mobile
- Tablets
- Android TV
Requires Android 9 (API 28) or newer.
| Module | Purpose |
|---|---|
app |
Phone and tablet app, entry point |
tv |
Android TV app |
common |
Shared domain, networking (OpenAPI client), DI |
resources |
Strings, drawables, translations |
Built with Kotlin, Jetpack Compose, Koin, Ktor and Coil.
- Install the latest stable Android Studio and JDK 17.
- Clone this repo and open it.
- Create
local.propertiesin the root folder with the values below:API key values are injected intoTRAKT_API_KEY = "PUT_YOUR_VALUE_HERE" # Optional YOUNIFY_API_KEY = "PUT_YOUR_VALUE_HERE" KLIPY_API_KEY = "PUT_YOUR_VALUE_HERE" # Release signing. Required by Gradle even for debug builds, # so use any placeholder values if you only build debug. KEYSTORE_ALIAS = PUT_YOUR_VALUE_HERE KEYSTORE_PASSWORD = PUT_YOUR_VALUE_HERE KEYSTORE_KEY_PASSWORD = PUT_YOUR_VALUE_HERE
BuildConfigas-is, so keep the quotes. - Download
google-services.jsonfrom your Firebase console project settings and put it in/app/google-services.json. The Firebase project needs apps for bothtv.trakt.traktandtv.trakt.trakt.v3(internal flavor). - Put
debug.keystoreandkeystore.jksin the root folder (same level aslocal.properties). Both are gitignored. For debug builds you can copy your local Android debug keystore from~/.android/debug.keystore.
You are all set!
The app has two flavors: playstore and internal (installs side by side with the .v3 package suffix).
./gradlew :app:assembleInternalDebug # internal debug build
./gradlew :app:assemblePlaystoreDebug # Play Store debug build
./gradlew ktlintCheck # lint, run before opening a PR
./gradlew ktlintFormat # auto-fix formattingWant to help translating Trakt into your native language? Have you spotted a mistake or an improvement?
Join the CrowdIn project: Translate Trakt
All contributions are welcome BUT, as a general rule we try to keep our Trakt apps in parity with what's happening on the Website.
If you wish to introduce something new into the app that's NOT already available on the website, please open a PR for the web first - or even better, start with a website GitHub issue or Featurebase request. This way your tokens and time will not be wasted ;)
If you see something that's already available on web but not yet in the Android app, PRs are welcome (it is still better to start with an issue first so we can assess and not duplicate any work by accident).
Let's keep the PRs small and focused on a single feature/issue. This way it is easier for everyone to understand it and review.
- Commits and PR titles follow Conventional Commits, e.g.
feat(app): add notes drawer. - Make sure
./gradlew ktlintCheckpasses. - Using an AI coding agent? It should follow
AGENTS.mdand the rules in.agents/rules/.
Licensed under the GNU General Public License v3.0.




