TvManiac

TvManiac is a personalized entertainment tracking and recommendation Multiplatform app. By utilizing Trakt, we can view shows, create a watchlist get statistics, and much more. This project aims to demonstrate KMP development capabilities. This is currently running on:

• Android: Compose
• iOS: SwiftUI

🚧 Under Heavy Development 🚧

This is my playground for learning Kotlin Multiplatform. With that said, I'm sure it's filled with bugs crawling everywhere, and I'm probably doing a couple of things wrong. So a lot is changing, but that shouldn't stop you from checking it out.

Android	iOS
screen-20230308-001558.mp4	iOSTvManiacDemo.mp4

🖥 Project Setup & Environment

Requirements

• Zulu Java 17
• You require the latest Android Studio release to be able to build the app.
• Install KMP Plugin. Checkout this setup guide.

API Keys

To use the Trakt API, you'll need to create a new API app. & for TMDb, create an account and generate an API key if you don't have one. Once you have your keys, add them to config.yaml. If the file is unavailable, navigate to the root dir and create a symlink.

ln -s core/util/src/commonMain/resources/config.yaml config.yaml

tmdbApiKey: "PUT_API_KEY_HERE"
traktClientId: "PUT_CLIENT_ID_HERE"
traktClientSecret: "PUT_CLIENT_SECRET_HERE"
traktRedirectUri: "PUT_CALLBACK_URI_HERE"

Opening iOS Project

• Navigate to the ios directory & open .xcodeproj

Android Screenshots

🔆 iOS Screenshots

Libraries Used

Android

• Accompanist
  • Insets
  • Pager Layouts
• Android-youtube-player - Youtube Player
• AppAuth - AppAuth for Android is a client SDK for communicating with OAuth 2.0 and OpenID Connect providers.
• Compose Lints - Custom lint checks for Jetpack Compose.
• Jetpack Compose
  • Coil - Image loading
  • Navigation - Navigation
• KenBurnsView - Immersive image.
• Leakcanary - Memory leak detection.
• ViewModel UI-related data holder, lifecycle aware.
• WorkManager Handle persistent work

Kmp - Common

• Kotlinx Serialization - De/Serializing JSON
• Coroutines - Concurrency & Threading
• DataStore Preferences - Data storage
• DateTime - Date & Time
• Flow-Redux
• Kermit - Logging
• kotlin-inject - Injection library.
• Ktor - Networking
• Kotest Assertions - Testing
• SQLDelight - Local storage
  • Coroutines Extensions Consume queries as Flow

iOS

• Kingfisher - Image library.
• OAuthSwift Swift-based OAuth library for iOS and macOS.
• TvManiac - TvManiac SwiftPackage.

Roadmap

Android

• Implement Watchlist
• Add More screen. Shows GridView
• Recommended Shows
• Implement pagination.
• Add Settings panel.
  • Dynamic theme change.
• Add Seasons UI
• Implement trakt auth & sign in
• Migrate to Material3
• Add Episode detail screen
• Add Watchlist
• Implement Search

iOS

• Add HomeScreen: Tabs & Empty UI
• Implement Discover UI
• Show Detail Screen
• Add Settings panel.
• Implement trakt auth & sign in
• Add Seasons UI
• Implement Search UI
• Implement Watchlist UI

Shared

• Use SQLDelight extensions to consume queries as Flow
• Refactor interactor implementation.
• Use koin for injection
• Modularize shared module
• Try out Flow-Redux
• Improve error handling.
• Fix paging
• Add test cases.

References

• Design Inspiration
• Code Snippets
• Touchlab KaMPKit project
• Tivi

License

Copyright 2021 Thomas Kioko

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.