Umapyoi Android

A project I built using modern Jetpack compose, Room, hilt, and data from umapyoi.net
Structured based on Google's recommended architecture.

Download

See releases for the latest APK

Tech Stack / Components

• Kotlin w/ flow and coroutines for asynchronous tasks
• Jetpack Libraries:
  • Compose: Declarative UI
  • ViewModel: Manage state and business logic and exposes state to the UI
  • Compose Navigation: Navigate between screens
  • Room: Cache data from the network for an offline-first experience
  • Hilt: Dependency Injection
• Retrofit: Transform Umapyoi.net's api into a java interface
• Testing:
  • Turbine - Framework to test kotlin flows
  • mockk - mocking framework for kotlin

Architecture

The architecture is structed so that data lives in one layer and is exposed through Flows to be consumed by the UI layer. Take the character list flow, where a user opens the list and taps the favorite button on a character

1. Source of data lives in umapyoi.net, the repository calls the api to get the character list
2. Repository inserts characters into Room through the dao
3. Dao exposes the list of characters as a flow, the repository also exposes the list of characters as a flow
4. Viewmodel consumes the flow and exposes it to the composable screen to render characters
5. Screen sends a favorite event, viewmodel then passes it to the repository, where eventually the entry is updated in room
6. Since Flow is being used, an updated list is emitted, and the ui receives this event to update the favorite button icon

The data layer is the sole source of truth, and all screens derive their UI based on this data. This ensures that when the data is shown in multiple screens, only one version of that data is shown.

• A user is able to set a favorite character in both the list and detailed page. Changes to this are automatically reflected in both pages since the character data is modified and comes from one source

Version History

• 0.1
  • View character from Umamusume and their support cards
  • Filter characters/cards by searching
  • Support favoriting characters

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Inspiration, code snippets, etc.

• Pokedex-Compose
• Now in Andorid
• README-Template.md
• Icons downloaded from flaticon.com