Bronco for Reddit is a free, open-source Reddit client for Android built to demonstarte the use of multi-module, clean code MVVM architecture in Android projects. It is an offline-first app built using Jetpack Compose and adheres to Material 3 guidelines.
🚧 Currently, the app is in its MVP stage, and I plan to add more features in future updates. These updates will further demonstrate the scalability, testability, and flexibility of this architecture. 🚧
This is a high level multi module dependency graph. For detailed dependencies checkout module wise dependency graph.
This project follows modularization by feature & layer as described in this video. This approach ensures that modules are both highly cohesive and loosely coupled, while also reducing the redundant code.
This architecture leverages the Dependency Inversion principle (DIP). High-level modules (e.g., presentation) should not depend on low-level modules (e.g., data). Instead, both should depend on abstractions (e.g., domain). Learn more
Delegates are used for module to module communication. Delegates are powerful because they enable class-level runtime polymorphism, promoting the use of composition for code reuse. Checkout /app/delegates.
* There are many features. Showing only 3 in the diagram for the sake of simplicity.
I have added unit tests for the :search module. checkout the unit test here.
🚧 Unit test for the other modules are work in progress 🚧.
If you find this project valuable or if you like the app, please give it a star ⭐️! Your support means a lot and motivates me to continue improving the project. 🙏
MIT License
Copyright (c) 2024 Anmol Singh Sahi
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.