An MVP android application which displays the xkcd comics, allowing users to save their favourite comics for offline viewing. Users can also share comics with their friends as well as search for comics using either text or numbers.
In this MVP, the following features were implemented:
- browse through the comics
- see the comics details including it's description
- search for comics by the comic number as well as text
- favorite the comics, which would be available offline too
- send comic to others
- support multiple form factor (portrait and landscape design for normal screen)
Given that this is an MVP and that we need to continually iterate, extend and add features to app, I came up with multi-module clean architecture where each feature has it own module. Overall, the app has the following modules:
- app module: The app module which integrate all the other modules together forming the whole app.
- common module: This module houses the codes that are common to all the other modules or codes that are atleast shared between two modules
- browsecomics module: This module holds the code that fetch and disply comics as the user browses through the comics
- favorite module: Holds code related to favoriting comics and viewing them offline
- search module: Holds the logic for searching comics either by number or text
At the presentation layer of the architecture, I used MVVM with Unidirectional Data Flow (UDF) which ensure that states in the application flows from one directions and thus easier to manage and manipulate.
- Hilt for dependencies injections
- deeplinks for navigating between modules
Wrote units and integration tests for viewModels and repository. I didn't unit tests the usecases as that wouldn't benefit us since the usecases integration with the viewModels and repository had already been tested.
