Skip to content

About

Open source official native Trakt client for Android / Android TV

Resources

Stars

82 stars

Watchers

4 watching

Forks

Latest commit

 

History

2,281 Commits

Folders and files

Repository files navigation

Logo

Trakt for Android

Track everything you watch, wherever you stream it.

Version Commits Stars Lint

Get it on Google Play


image   image   image   image

Supported Form Factors

  • Mobile
  • Tablets
  • Android TV

Requires Android 9 (API 28) or newer.

Project Structure

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.

Getting Started

  1. Install the latest stable Android Studio and JDK 17.
  2. Clone this repo and open it.
  3. Create local.properties in the root folder with the values below:
    TRAKT_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
    API key values are injected into BuildConfig as-is, so keep the quotes.
  4. Download google-services.json from your Firebase console project settings and put it in /app/google-services.json. The Firebase project needs apps for both tv.trakt.trakt and tv.trakt.trakt.v3 (internal flavor).
  5. Put debug.keystore and keystore.jks in the root folder (same level as local.properties). Both are gitignored. For debug builds you can copy your local Android debug keystore from ~/.android/debug.keystore.

You are all set!

Building

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 formatting

Localisation 🌐

Want to help translating Trakt into your native language? Have you spotted a mistake or an improvement?

Join the CrowdIn project: Translate Trakt

Contributions 👏

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.

License

Licensed under the GNU General Public License v3.0.

About

Open source official native Trakt client for Android / Android TV

Resources

Stars

82 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages