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 work in progress, and I plan to add more features in future updates. These updates will further demonstrate the scalability, testability, and flexibility of this architecture. 🚧
| Working Demo |
|---|
screen_recording.mp4 |
| Light | Dark |
|---|---|
 |
 |
 |
 |
 |
 |
 |
 |
Go to the Releases to download the latest APK.
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.
- Material3 - M3 opens up new possibilities for both brand colors and individual color preferences to converge in one-of-a-kind experiences. The color system embraces the need for color to reflect an app’s design sensibility, while also honoring the settings that individuals choose for themselves.
- Coroutines - Kotlin solves Asynchronous or non-blocking programming problem in a flexible way by providing coroutine support at the language level and delegating most of the functionality to libraries.
- Hilt - Hilt is a dependency injection library for Android that reduces the boilerplate of doing manual dependency injection in your project.
- Room - The Room persistence library provides an abstraction layer over SQLite to allow for more robust database access while harnessing the full power of SQLite.
- Ktor-client - Ktor is a framework to easily build connected applications
- Kotlinx Serialization - Kotlin serialization consists of a compiler plugin, that generates visitor code for serializable classes, runtime library with core serialization API and support libraries with various serialization formats.
- Navigation Compose - Navigation Compose enables you to navigate between composables while taking advantage of the Navigation component’s infrastructure and features.
- ViewModel - The ViewModel class is designed to store and manage UI-related data in a lifecycle conscious way. The ViewModel class allows data to survive configuration changes such as screen rotations.
- SplashScreen - The SplashScreen API enables a new app launch animation for all apps when running on a device with Android 12 or higher. This includes an into-app motion at launch, a splash screen showing your app icon, and a transition to your app itself.
- Material Icons - Material Design system icons as seen on Google Fonts.
- Work Manager - WorkManager is a tool that provides APIs to schedule and runs background tasks persistently.
- Media3 ExoPlayer - Media3 ExoPlayer is used to play the reddit videos.
- Turbine - To unit test kotlin flows.
I have added unit tests for the :search module. checkout the unit test here - search module unit tests.
🚧 Unit test for the other modules are work in progress 🚧.
- Code Cleanup - While this project is great for understanding industry-standard architecture, some files still contain duplicate code and need cleanup. My plan is to refactor the code using Design Patterns and SOLID principles. Along the way, I’ll also be writing articles to demonstrate how I approached the cleanup process.
- More Features - I will be adding more features like Subreddit page, user profile page and login.
- M3 Expressive - The design will be kept up to date by adding the M3 expressive components.
- Adaptive Design - Make the app support multiple devices like foldables, tablets and the Android XR.
- Kotlin Multiplatform - The goal is to take the app multiplatform by integration the kotlin multiplatform technology.
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.