Skip to content

Commit cb7a465

Browse files
author
Ashwini Kumar
committed
Update readme
1 parent 6631ccc commit cb7a465

1 file changed

Lines changed: 9 additions & 45 deletions

File tree

README.md

Lines changed: 9 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,38 @@
11
![Android CI](https://github.com/ashwini009/TvFlix/workflows/Android%20CI/badge.svg?branch=master&event=push) ![GitHub top language](https://img.shields.io/github/languages/top/ashwini009/TvFlix?style=plastic) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![API](https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=21) ![GitHub stars](https://img.shields.io/github/stars/ashwini009/TvFlix?style=social) ![GitHub forks](https://img.shields.io/github/forks/ashwini009/TvFlix?style=social)
22

33

4-
# TvFlix :tv:
4+
# TvFlix :tv:
55

6-
The aim of this app is to replicate the high level functionality of www.tvmaze.com and showcase an android app out of it.
6+
The aim of this app is to replicate the high level functionality of www.tvmaze.com and showcase an android app out of it.
77
It connects with [TVDB API](https://api.thetvdb.com) to give you popular shows and let you mark anyone as favorite.
88
TvFlix consists of 3 pieces of UI right now:
99
1. Home with Popular Shows
1010
2. Favorites
1111
3. All Shows
1212

13-
This app is under development. :construction_worker: :hammer_and_wrench:
14-
1513
*Note: TvFlix is an unofficial app built only for learning and sharing the latest concepts with #AndroidDevs*
1614

1715
## Android Development and Architecture
1816

1917
* The entire codebase is in [Kotlin](https://kotlinlang.org/)
20-
* Uses Kotlin [Coroutines](https://kotlinlang.org/docs/reference/coroutines/coroutines-guide.html).
18+
* Uses [Jetpack Compose](https://developer.android.com/jetpack/compose) for UI
19+
* Uses Kotlin [Coroutines](https://kotlinlang.org/docs/reference/coroutines/coroutines-guide.html) and [StateFlow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/) for reactive state management
2120
* Uses MVVM Architecture by [Architecture Components](https://developer.android.com/topic/libraries/architecture/). Room, ViewModel, Paging
2221
* Uses [Hilt Android](https://developer.android.com/training/dependency-injection/hilt-android) with [Dagger](https://dagger.dev/) for dependency injection
22+
* Uses [KSP](https://developer.android.com/build/migrate-to-ksp) for annotation processing
2323
* Unit Testing by [Mockito](https://github.com/mockito/mockito)
2424
* Tests Coroutines and architecture components like ViewModel
25-
* UI Test by [Espresso](https://developer.android.com/training/testing/espresso) based on [Robot Pattern](https://academy.realm.io/posts/kau-jake-wharton-testing-robots/)
25+
* UI Test by [Compose Testing](https://developer.android.com/jetpack/compose/testing)
2626
* Uses [Kotlin Coroutines Test](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-test/) to unit test Kotlin Coroutines
27-
* Uses [StateFlow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/) as a replacement over LiveData as a state-holder observable
2827
* Uses [Firebase Remote Config](https://firebase.google.com/products/remote-config) for experimentation and feature rollout
2928
* Uses [Firebase App Distribution](https://firebase.google.com/products/app-distribution) for internal distribution and quality testing
30-
31-
## Further Reading
32-
33-
There are several articles written on this repository which state the design and architecture.
34-
35-
### Kotlin Everywhere. Coroutines, Tests, Robots and much more…
36-
37-
The TvFlix complete repository has been re-written in Kotlin with Coroutines covering
38-
Unit Tests across ViewModels and UI tests for the app.
39-
Know more:
40-
[Kotlin Everywhere. Coroutines, Tests, Robots and much more…](https://proandroiddev.com/kotlin-everywhere-coroutines-tests-robots-and-much-more-b02030206cc9)
41-
42-
### MVVM using Android Architecture Components
43-
44-
The codebase tries to follow Uncle Bob Clean Code Architecture with [SOLID principles](https://en.wikipedia.org/wiki/SOLID).
45-
Know more:
46-
[Migration from MVP to MVVM using Android Architecture Components](https://medium.com/@kumarashwini/migration-from-mvp-to-mvvm-using-android-architecture-components-4bc058a1f73c)
47-
48-
### Pagination using Paging Library
49-
50-
The Shows screen displays the list of shows fetched from TvMaze API using [Paging3](https://developer.android.com/topic/libraries/architecture/paging/v3-overview) of Android Architecture Components. It also handles the retry if any network error occurred. Recently the repository has been [migrated to use Paging3](https://github.com/reactivedroid/TvFlix/pull/14).
51-
Paging3 is in heavy development, and if you want to catch up with stable library(Paging 2), then check out this blog
52-
[Pagination using Paging Library with RxJava and Dagger](https://medium.com/@kumarashwini/pagination-using-paging-library-with-rxjava-and-dagger-d9d05dbd8eac)
53-
54-
### Room Persistence Library
55-
56-
The Favourites screen displays the list of shows marked favourites from the Home screen. The user can add/remove from
57-
the favorites as and when required. The implementation of the favorites is done using `Room` Persistence Library with RxJava and Dagger.
58-
Know more:
59-
[Room with RxJava and Dagger](https://medium.com/@kumarashwini/room-with-rxjava-and-dagger-2722f4420651)
60-
61-
### Static Code Analysis
62-
63-
TvFlix 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.
64-
Know more:
65-
[Static Code Analysis for Android Using FindBugs, PMD and CheckStyle](https://blog.mindorks.com/static-code-analysis-for-android-using-findbugs-pmd-and-checkstyle-3a2861834c6a)
29+
* Uses [Paging3](https://developer.android.com/topic/libraries/architecture/paging/v3-overview) for paginated show listing
6630

6731
## Contributions
6832

6933
If you have found an issue in this sample, please file it.
7034
Better yet, if you want to contribute to the repository, go ahead, any kind of patches are encouraged,
71-
and may be submitted by forking this project and submitting a pull request.
35+
and may be submitted by forking this project and submitting a pull request.
7236
If you have something big in mind, or any architectural change, please raise an issue first to discuss it.
7337

7438
## License
@@ -93,4 +57,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
9357
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
9458
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
9559
SOFTWARE.
96-
```
60+
```

0 commit comments

Comments
 (0)