Zobaze Refactor Task is an Android application designed to showcase modern Android development practices, including dependency injection with Hilt, network communication with Retrofit, and a clean architecture approach with Model-View-ViewModel (MVVM) pattern.
To build the project, ensure you have Android Studio Arctic Fox or later and the Android SDK setup on your machine. Follow these steps:
- Clone the repository to your local machine.
- Open Android Studio and select "Open an Existing Project", navigating to the cloned repository.
- Let Android Studio download any required dependencies.
- Build the project by selecting "Build > Make Project".
The project follows the MVVM architecture pattern to separate the UI logic from the business logic, facilitating easier testing and maintenance. It is structured into several packages for clarity and separation of concerns:
data: Contains classes related to data handling, including API services, repositories, and models.databinding: Includes data binding models used to bind UI components in XML layouts to data sources.di: Holds the Dependency Injection setup using Hilt, including modules for providing application-wide dependencies.ui: Contains UI-related classes such as Activities, Fragments, ViewModels, and Adapters.
- Hilt for dependency injection, simplifying the provision and management of dependencies across the application.
- Retrofit with OkHttp for making API calls and handling network communication.
- Timber for logging.
- Android Jetpack Libraries (LiveData, ViewModel, DataBinding) to implement the app according to the recommended best practices by Google.
The project utilizes several dependencies to implement its functionality:
- AndroidX libraries for backward-compatible versions of Android components.
- Hilt for dependency injection.
- Retrofit and OkHttp for network requests.
- Gson for JSON parsing.
- Timber for logging.
For a full list of dependencies, refer to the build.gradle (Module: app) file.
Given the number of dependencies and the size of the project, MultiDex support is enabled to allow the app to exceed the 64K method count limit.
To run the application:
- Connect an Android device or use the Android Emulator.
- Select the device from the target device dropdown in Android Studio.
- Run the application by clicking the "Run" button or pressing Shift + F10.