Skip to content

Latest commit

 

History

History
114 lines (82 loc) · 5.54 KB

README.md

File metadata and controls

114 lines (82 loc) · 5.54 KB
Raw

Header

Gallerit

Kotlin AGP Gradle

Kotlin Weekly

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

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.
  • Retrofit - 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.

Architecture

Reddit API

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

GitHub Actions

GitHub Actions verify project correctness on every push to master branch and on every PR. All of the tasks run in parallel.

These are all of the Gradle tasks that are workflows:

  • ./gradlew test - Run unit tests
  • ./gradlew detekt - Run detekt
  • ./gradlew lint - Run Android lint
  • ./gradlew ktlintCheck - Run ktlint check
  • ./gradlew assembleDebug - Build debug APK

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.

License

All the code available under the MIT License. See LICENSE.

MIT License

Copyright (c) 2020 Mario Salvatore

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.