cybernetics/gallerit

A sample Android gallery to search images posted on Reddit built using modern Android development tools (Architecture Components, MVVM, Coroutines, Flow, Navigation, Retrofit, Room, Koin)

Gallerit

Gallerit is a small demo application that presents a modern approach to Android development with up to date tech-stack. The goal of the project is to demonstrate best practices using modern Android development tools and presenting an architecture that is scalable, maintainable, and testable.

Project characteristics

• 100% Kotlin
• Model-View-ViewModel
• Repository Pattern
• A single activity architecture
• Android Jetpack
• Reactive UI
• Testing
• Dependency Injection
• Gradle Kotlin DSL
• Material Design
• GitHub Actions

Libraries

• Coroutines - For managing background threads.
• Flow - A cold asynchronous data stream that sequentially emits values.
• StateFlow - A Flow that represents a state with a single updatable data value.
• Jetpack
  • ViewModel - Store UI-related data that isn't destroyed on app rotations.
  • LiveData - Build data objects that notify views when the underlying database changes.
  • Lifecycle - Create a UI that automatically responds to lifecycle events.
  • Navigation - Handle everything needed for in-app navigation.
  • Room - Access your app's SQLite database with in-app objects and compile-time checks.
• Retrofit2 - A type-safe HTTP client.
• Glide - An image loading and caching library.
• PhotoView - Implementation of ImageView that supports zooming.
• Koin - A pragmatic lightweight dependency injection framework.
• Timber - A logger with a small, extensible API.
• MockK - Mocking library for Kotlin.
• Kotest - Powerful, elegant and flexible test framework for Kotlin.
• and more...

Architecture

Gallerit is based on MVVM architecture, fetching data from the network and integrating persisted data in the database via repository pattern.

Reddit API

Gallerit uses the Reddit API to load images on the gallery screen.

Getting started

There are a few ways to open this project.

Android Studio

1. Android Studio -> File -> New -> Project from Version Control
2. Enter https://github.com/auron567/Gallerit.git into URL field

Command line + Android Studio

1. Run git clone https://github.com/auron567/Gallerit.git
2. Android Studio -> File -> Open

Contribute

If you want to contribute to this application, you're always welcome! You can contribute by filing issues, bugs and PRs.