TvManiac

TvManiac is a personalized entertainment tracking and recommendation Multiplatform app. By utilizing TMDB, 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
Android_Demo.mp4	iOS_App_Demo.mov

Important

To fetch data, you will need to create a TMDB API app 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, then add the API keys.

🖥 Project Setup & Environment

Requirements

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

Opening iOS Project

• Navigate to the ios directory & open .xcodeproj

Architecture Overview

• TODO: Add detail architecture

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
• KenBurnsView - Immersive image.
• Leakcanary - Memory leak detection.

Kmp - Common

• Coroutines - Concurrency & Threading
• DataStore Preferences - Data storage
• DateTime - Date & Time
• Decompose - Kotlin Multiplatform library for breaking down your code into lifecycle-aware business logic components (aka BLoC).
• Kermit - Logging
• kotlin-inject - Injection library.
• Kotlinx Serialization - De/Serializing JSON
• Ktor - Networking
• Kotest Assertions - Testing
• Multiplatform Paging A library that adds additional Kotlin/Multiplatform targets to AndroidX Paging, and provides UI components to use Paging on iOS.
• SQLDelight - Local storage
  • Coroutines Extensions Consume queries as Flow

iOS

• SDWebImage - Async image downloader.
• OAuthSwift Swift-based OAuth library for iOS and macOS.
• ScalingHeaderScrollView
• Youtube PlayerKit - Swift Youtube Player

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
• Implement Paging
• 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
• Update show detail UI
• Add Seasons Detail UI
• Implement Paging
• Add Episode detail screen
• Add Watchlist
• Implement Search

Shared

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

References & Inspiration

• 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.