The aim of this app is to replicate the high level functionality of www.tvmaze.com and showcase an android app out of it. It connects with TVDB API to give you popular shows and let you mark anyone as favorite TvMaze consists of 3 pieces of UI right now, Home with Popular Shows, Favorites and All Shows. This app is under heavy development.
- The entire codebase is in Kotlin
- Uses Kotlin Coroutines
- Uses MVVM Architecture by Architecture Components. Room, LiveData, ViewModel, Paging
- Uses dagger-android for dependency injection
- Unit Testing by Mockito
- Tests Coroutines and architecture components like ViewModel
- UI Test by Espresso based on Robot Pattern
Note For reference, the Java Codebase has been tagged on tvmaze_java. Just checkout the tag and you are in TvMaze Java Land.
There are several articles written on this repository which states the design and architecture.
The TvMaze complete repository has been re-written in Kotlin with Coroutines covering Unit Tests across ViewModels and UI tests for the app. Know more: Kotlin Everywhere. Coroutines, Tests, Robots and much more…
The codebase tries to follow Uncle Bob Clean Code Architecture with SOLID principles. Know more: Migration from MVP to MVVM using Android Architecture Components
The Shows screen displays the list of shows fetched from TvMaze API using PagingLibray of Android Architecture Components.
It also handles the retry if any network error occurred.
Know more:
Pagination using Paging Library with RxJava and Dagger
The Favourites screen displays the list of shows marked favourites from the Home screen. The user can add/remove from
the favorites as and when required. The implementation of the favorites is done using Room Persistence Library with RxJava and Dagger.
Know more:
Room with RxJava and Dagger
TvMaze has Static Code Analysis tools like FindBugs, PMD and Checkstyle integrated. These tools help in finding potential bugs that would have been missed and help in making the codebase clean. Know more: Static Code Analysis for Android Using FindBugs, PMD and CheckStyle
If you have found an issue in this sample, please file it. Better yet, if you want to contribute to the repository, go ahead, any kind of patches are encouraged, and may be submitted by forking this project and submitting a pull request. If you have something big in mind, or any architectural change, please raise an issue first to discuss it.
Copyright 2019 Ashwini Kumar
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
http://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.