{"id":13608576,"url":"https://github.com/auron567/Gallerit","last_synced_at":"2025-04-12T17:32:10.165Z","repository":{"id":55558002,"uuid":"278583026","full_name":"auron567/Gallerit","owner":"auron567","description":"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)","archived":false,"fork":false,"pushed_at":"2020-12-22T07:24:30.000Z","size":2225,"stargazers_count":219,"open_issues_count":2,"forks_count":20,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-07T14:41:17.115Z","etag":null,"topics":["android","coroutines","gradle-kotlin-dsl","koin","kotlin","kotlin-flow","livedata","mockk","mvvm","navigation","repository-pattern","retrofit2","room","singleactivityapp","stateflow","viewmodel"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/auron567.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-10T08:39:23.000Z","updated_at":"2024-06-27T09:35:55.000Z","dependencies_parsed_at":"2022-08-15T03:10:40.359Z","dependency_job_id":null,"html_url":"https://github.com/auron567/Gallerit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/auron567%2FGallerit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/auron567%2FGallerit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/auron567%2FGallerit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/auron567%2FGallerit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/auron567","download_url":"https://codeload.github.com/auron567/Gallerit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248605203,"owners_count":21132126,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","coroutines","gradle-kotlin-dsl","koin","kotlin","kotlin-flow","livedata","mockk","mvvm","navigation","repository-pattern","retrofit2","room","singleactivityapp","stateflow","viewmodel"],"created_at":"2024-08-01T19:01:28.396Z","updated_at":"2025-04-12T17:32:05.154Z","avatar_url":"https://github.com/auron567.png","language":"Kotlin","readme":"![Header](media/GalleritHeader.png)\n\n# Gallerit\n\n[![Kotlin](https://img.shields.io/badge/Kotlin-1.4.0-blue.svg)](https://kotlinlang.org)\n[![AGP](https://img.shields.io/badge/AGP-4.0.1-blue.svg)](https://developer.android.com/studio/releases/gradle-plugin)\n[![Gradle](https://img.shields.io/badge/Gradle-6.1.1-blue.svg)](https://gradle.org)\n\n[![Kotlin Weekly](https://img.shields.io/badge/Kotlin%20Weekly-%23211-blueviolet.svg)](https://mailchi.mp/kotlinweekly/kotlin-weekly-211)\n\n**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.\n\n## Project characteristics\n\n- 100% [Kotlin](https://kotlinlang.org/)\n- Model-View-ViewModel\n- Repository Pattern\n- A single activity architecture\n- [Android Jetpack](https://developer.android.com/jetpack)\n- Reactive UI\n- Testing\n- Static analysis tools\n- Dependency Injection\n- [Gradle Kotlin DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html)\n- Material Design\n- [GitHub Actions](https://github.com/features/actions)\n\n## Libraries\n\n- [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - For managing background threads.\n- [Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/) - A cold asynchronous data stream that sequentially emits values.\n- [StateFlow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-state-flow/) - A Flow that represents a state with a single updatable data value.\n- Jetpack\n  - [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Store UI-related data that isn't destroyed on app rotations.\n  - [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - Build data objects that notify views when the underlying database changes.\n  - [Lifecycle](https://developer.android.com/topic/libraries/architecture/lifecycle) - Create a UI that automatically responds to lifecycle events.\n  - [Navigation](https://developer.android.com/guide/navigation) - Handle everything needed for in-app navigation.\n  - [Room](https://developer.android.com/topic/libraries/architecture/room) - Access your app's SQLite database with in-app objects and compile-time checks.\n- [Retrofit](https://square.github.io/retrofit/) - A type-safe HTTP client.\n- [Glide](https://bumptech.github.io/glide/) - An image loading and caching library.\n- [PhotoView](https://github.com/chrisbanes/PhotoView) - Implementation of ImageView that supports zooming.\n- [Koin](https://insert-koin.io/) - A pragmatic lightweight dependency injection framework.\n- [Timber](https://github.com/JakeWharton/timber) - A logger with a small, extensible API.\n- [MockK](https://mockk.io/) - Mocking library for Kotlin.\n- [Kotest](https://github.com/kotest/kotest) - Powerful, elegant and flexible test framework for Kotlin.\n- [and more...](buildSrc/src/main/java/Dependencies.kt)\n\n## Architecture\n\nGallerit is based on [MVVM](https://developer.android.com/jetpack/guide#recommended-app-arch) architecture, fetching data from the network and integrating persisted data in the database via repository pattern.\n\n![Architecture](media/GalleritArchitecture.png)\n\n## Reddit API\n\nGallerit uses the [Reddit API](https://www.reddit.com/dev/api/) to load images on the gallery screen.\n\n## GitHub Actions\n\n[GitHub Actions](https://github.com/auron567/Gallerit/actions) verify project correctness on every push to `master` branch and on every PR. All of the tasks run in parallel.\n\nThese are all of the Gradle tasks that are [workflows](https://github.com/auron567/Gallerit/tree/master/.github/workflows):\n\n- `./gradlew test` - Run unit tests\n- `./gradlew detekt` - Run detekt\n- `./gradlew lint` - Run Android lint\n- `./gradlew ktlintCheck` - Run ktlint check\n- `./gradlew assembleDebug` - Build debug APK\n\n## Getting started\n\nThere are a few ways to open this project.\n\n**Android Studio**\n\n1. Android Studio -\u003e File -\u003e New -\u003e Project from Version Control\n2. Enter `https://github.com/auron567/Gallerit.git` into URL field\n\n**Command line + Android Studio**\n\n1. Run `git clone https://github.com/auron567/Gallerit.git`\n2. Android Studio -\u003e File -\u003e Open\n\n## Contribute\n\nIf you want to contribute to this application, you're always welcome! You can contribute by filing issues, bugs and PRs.\n\n## License\n\nAll the code available under the MIT License. See [LICENSE](LICENSE).\n\n```\nMIT License\n\nCopyright (c) 2020 Mario Salvatore\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","funding_links":[],"categories":[":art: Pattern","Kotlin"],"sub_categories":["MVVM"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fauron567%2FGallerit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fauron567%2FGallerit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fauron567%2FGallerit/lists"}