Description

• This Pull request create the initial features of the App
• Creates List of top Images screen
• Creates Search screen together with search functionality
• Creates Image detail screen
• Creates Profile Screen

Approach

Architecture

This app has an architecture in place to allow the App to Scale, improve Quality and Robustness and Allow the App to Scale. This also makes the App to Scale

• Separation of concern
• Drive UI from Data Model
• Make functionality easily changeable or droppable
• Make Code easier to read
• Make use of good practices and Jetpack libraries(Architecture components)

Layers

Domain Layer

• Sits between the UI and Data layer
• Used in this project to encapsulate business logic
• Enables use-cases to be reused in multiple view model
• Defines the repository interface that drives the main functionality

Data Layer

• Contains the implementation of business logic(Repository Implementation)
• Gets data from the remote data source
• Cache's remote data to Local Room Database

Presentation/UI layer

• This layer is the layer that displays data to the user screen
• Contains view models that are lifecycle friendly and takes code away from our Activity/UI components
• Defines our architecture which is MVVM (Model View View-Model)
• Contains our states that handle logic like loading

Dependency Injection

• Used Hilt Dagger library for dependency injection
• Allows classes to define their dependencies without constructing them
• Also brings all the layers of the App together
• Helps UI layer to be driven from data layer

Screenshots

...

Libraries used

• Retrofit - Android Network Client, Used to consume API from Pixabay API
• Room - SQLite ORM - used to save data to the phone's database for caching
• Hilt Dagger - Used for dependency Injection
• Coroutines - Used to execute code asynchronously
• Jetpack Compose - Used to write the declarative UI of the App
• Material Design - Give the App a theme and generally improve UI of the App
• Coil Image - Image Loading library
• Lifecycle library - Majorly to define the ViewModels of the app
• Navigation - To navigate to different screens of the App

How should this be manually tested?

• Clone the App, Run it in Android Studio and install it on your phone

Type of change

Please select the relevant option

• [ ] Bug fix(a non-breaking change that fixes an issue)
• [x] New feature(a non-breaking change that adds functionality)
• [ ] Breaking change(fix a feature that would cause existing functionality to not work as expected)
• [ ] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes

• [ ] End to end test
• [ ] Integration test
• [x] unit test

Checklist:

• [x] My code follows the style guidelines
• [x] I have linted my code prior to submission
• [ ] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] I have added tests
• [x] New and existing tests pass locally with my changes