Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hivian/randomuserscomposeandroid
A simple Android app built with Kotlin, using Jetpack Compose and Koin. Project based on clean architecture and MVVM pattern.
https://github.com/hivian/randomuserscomposeandroid
android android-jetpack clean-architecture jetpack-compose koin kotlin mvvm retrofit room-database
Last synced: about 2 months ago
JSON representation
A simple Android app built with Kotlin, using Jetpack Compose and Koin. Project based on clean architecture and MVVM pattern.
- Host: GitHub
- URL: https://github.com/hivian/randomuserscomposeandroid
- Owner: hivian
- License: mit
- Created: 2022-10-28T10:23:44.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-24T14:35:50.000Z (8 months ago)
- Last Synced: 2024-11-06T13:29:37.517Z (3 months ago)
- Topics: android, android-jetpack, clean-architecture, jetpack-compose, koin, kotlin, mvvm, retrofit, room-database
- Language: Kotlin
- Homepage:
- Size: 73.4 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
RandomUsersComposeAndroid
A simple demo app built with Kotlin, using Jetpack Compose, based on clean architecture and MVVM pattern.
Data fetched from https://randomuser.me api and saved to Android database
This project is the Android copy of that [Kotlin Multiplatform project](https://github.com/hivian/RandomUsersComposeMultiplatform)
## Preview
## Features
- [x] Offline mode
- [x] Pagination: infinite scroll
- [x] Reverse geocoding with Maps SDK
- [x] Specific error messages with retry action
- [x] Dark mode
## Tech stack
* [Compose](https://developer.android.com/jetpack/compose) - Declarative and simplified way for UI development
* [Maps Compose](https://developers.google.com/maps/documentation/android-sdk/maps-compose) - Compose for the Google Maps SDK
* [Koin](https://insert-koin.io/docs/quickstart/android/) - Dependency injection
* [Navigation](https://developer.android.com/topic/libraries/architecture/navigation) - Screen routing handler
* [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - UI related data holder, lifecycle aware
* [Room](https://developer.android.com/topic/libraries/architecture/room) - Local database
* [Retrofit](https://square.github.io/retrofit/) - Networking client
* [Coroutines](https://developer.android.com/topic/libraries/architecture/coroutines) - Concurrency design pattern for asynchronous programming
## Architecture
* SOLID principles
* MVVM clean architecture
* Modularization by feature and by layer
### Modules dependencies
```
App → homefeature
↳ core
```
### Layers dependencies
```
presentation → domain ← data
```
### Global package structure
```
com.hivian.randomusers # Root Module
├── app # Application entry point
└── MainActivity # Screen entry point
com.hivian.randomusers.homefeature # Main feature Module
├── di # Dependency injection module
├── data # Data layer
│ ├── mappers # DTO to domain models mapper
│ └── services # local & remote data source implementation
├── domain # Domain layer
│ ├── models # Domain models
│ ├── services # services contracts
│ └── usecases # Use cases encapsulation for presentation layer
└── presentation # Presentation layer
├── home # Main screen & viewModel
├── detail # Detail screen & viewModel
└── themes # Design system
com.hivian.randomusers.core # Core Module
├── di # Dependency injection module
├── data # Data sources
│ ├── models # Entities & DTO Models
│ ├── local # Local database client
│ │ ├── converters # Complex data serializer
│ │ └── dao # Data Access Object for Room
│ └── remote # Remote data client & data wrappers
├── domain # Domain layer
│ ├── base # Base classes
│ ├── extensions # Kotlin extensions
│ ├── services # Core services contracts
│ └── usecases # Core usecases
└── presentation # Presentation layer
├── navigation # Navigation routes
└── services # UI services implementation
```
## Download
Go to the [releases page](https://github.com/hivian/Android-Compose-MVVM/releases) to download the latest available apk.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details