A simple example of Clean code architecture with MVVM
Welcome to our GitHub repository showcasing a clean and efficient implementation of Android app architecture. In this project, we have leveraged the power of Clean Code Architecture along with MVVM pattern, Dagger Hilt for dependency injection, Retrofit for network communication, and Use Cases for business logic separation.
Features:
- Clean Code Architecture: Our project adheres to the principles of Clean Architecture, ensuring separation of concerns and maintainability.
- MVVM Pattern: We have adopted the Model-View-ViewModel architectural pattern to facilitate a clear separation of UI and business logic.
- Dagger Hilt: Dependency injection is handled seamlessly with Dagger Hilt, promoting modularity and testability of our codebase.
- Retrofit: Network requests are made efficiently using Retrofit, providing a robust mechanism for API communication.
- Use Cases: Business logic is encapsulated within Use Cases, promoting reusability, testability, and maintainability of our application.
Key Components:
- Presentation Layer: Activities and Fragments implementing the MVVM pattern, along with ViewModels.
- Domain Layer: Use Cases encapsulating business logic, ensuring separation from presentation and data layers.
- Data Layer: Repositories responsible for data operations, Retrofit service for API communication.
Getting Started:
To get started with our project:
- Clone the repository to your local machine.
- Open the project in Android Studio.
- Build and run the application on an emulator or physical device.
Contributing:
We welcome contributions to our project! Whether it's bug fixes, feature enhancements, or documentation improvements, feel free to submit pull requests. Please adhere to our coding standards and guidelines, ensuring consistency and maintainability.
License:
This project is licensed under the MIT License, allowing for open collaboration and use.
Acknowledgements:
We extend our gratitude to the open-source community for their invaluable contributions, and to the creators of Clean Code Architecture, MVVM pattern, Dagger Hilt, Retrofit, and Use Cases for providing powerful tools and frameworks.