tv-maniac

Introduction: Tv-Maniac is a personalized entertainment tracking and recommendation Multiplatform app (Android & iOS) for tracking TV Shows using TMDB API.
More: Author   ReportBugs   
Tags:

Check kmp compose swiftui

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

[!IMPORTANT] To fetch data, you will need to create a TMDB API app and generate an API key if you don't have one. Each platform has its own resource key file:

  • Android: Add your API keys to core/util/src/androidMain/resources/dev.yaml
  • iOS: Add your API keys to ios/ios/Resources/dev.yaml

In both files, replace the placeholder values with your actual API keys.

🖥 Project Setup & Environment

Requirements

Opening iOS Project

  • Navigate to the ios directory & open .xcodeproj

Git Hooks

The project uses Git hooks to enforce code quality checks before commits. To install the hooks, run:

./scripts/install-git-hooks.sh

This will install the following hooks:

  • pre-commit: Runs code formatting checks using Spotless before allowing a commit. If the checks fail, the commit will be aborted.

Architecture Overview

  • [ ] TODO: Add detail architecture

TvManiac Architecture

Libraries Used

Android

Kmp - Common

iOS

Roadmap

Android

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

iOS

  • [x] Add HomeScreen: Tabs & Empty UI
  • [x] Implement Discover UI
  • [x] Show Detail Screen
  • [x] Add Settings panel.
  • [x] Implement trakt auth & sign in
  • [x] Update show detail UI
  • [x] Add Seasons Detail UI
  • [x] Implement Paging
  • [x] Implement Search
  • [ ] Add Episode detail screen

Shared

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

References & Inspiration

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.
Apps
About Me
GitHub: Trinea
Facebook: Dev Tools