Imagine - GitLite

KO | EN

gitlite — search

#javascript #ai #typescript #llm #go #golang #android #deep-learning #java #kubernetes #awesome-list #pytorch #ios #open-source

Imagine

(★ 357)

An simple image gallery app utilizing Unsplash API to showcase modern Android development architecture (MVVM + Kotlin + Retrofit2 + Hilt + Coroutines + Kotlin Flow + mockK + Espresso + Junit)

File Explorer

Download Latest Version (.zip)

- - deploy-to-play.yml
  - firebase-distribute-workflow.yml
  - pr_worklow.yml
  - unit_tests.yml
- ci-gradle.properties
- dependabot.yml
- .gitignore
- build.gradle
- google-services.json
- proguard-rules.pro
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- Imagine-UnitTests.PNG
- PhotoDetailsDay.png
- PhotoDetailsNight.png
- PopularPhotosDay.png
- PopularPhotosNight.png
- SearchResultsDay.png
- SearchResultsNight.png
- copyright.kt
.gitignore
build.gradle
Dangerfile
Gemfile
gradle.properties
gradlew
gradlew.bat
Imagine-App.apk
LICENSE
README.md
settings.gradle

# Installation Guide

1. Get the code

git clone https://github.com/wajahatkarim3/Imagine

Downloads the entire project code from GitHub to your computer.

cd Imagine

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

cd app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

3. Ruby

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Ruby Ruby is required to use the bundle command.

bundle install

Installs the Ruby libraries listed in the Gemfile.

✅ If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Imagine App
An simple image gallery app utilizing Unsplash API.

![Tests](https://github.com/wajahatkarim3/Imagine/workflows/Tests/badge.svg)  [![codecov](https://codecov.io/gh/wajahatkarim3/Imagine/branch/main/graph/badge.svg?token=rYP14UIojU)](https://codecov.io/gh/wajahatkarim3/Imagine)

<div align="center">
  <sub>Built with ❤︎ by
  <a href="https://twitter.com/WajahatKarim">Wajahat Karim</a> and
  <a href="https://github.com/wajahatkarim3/Imagine/graphs/contributors">
    contributors
  </a>
</div>
<br/>

<div align="center">
  <img src="https://github.com/wajahatkarim3/Imagine/blob/main/screenshots/PopularPhotosDay.png" width="230px" />  <img src="https://github.com/wajahatkarim3/Imagine/blob/main/screenshots/PhotoDetailsDay.png" width="230px" />  <img src="https://github.com/wajahatkarim3/Imagine/blob/main/screenshots/SearchResultsDay.png" width="230px" /><br>
  <img src="https://github.com/wajahatkarim3/Imagine/blob/main/screenshots/PopularPhotosNight.png" width="230px" />  <img src="https://github.com/wajahatkarim3/Imagine/blob/main/screenshots/PhotoDetailsNight.png" width="230px" />  <img src="https://github.com/wajahatkarim3/Imagine/blob/main/screenshots/SearchResultsNight.png" width="230px" />
</div>

<br/>

## Features
* Popular photos with pagination support
* Quickly explore top categories like Cars, Mountains, Animals, Interior etc.
* Search query with pagination support
* Comes in both light and dark mode.

## Architecture
* Built with Modern Android Development practices
* Utilized Usecase, Repository pattern for data
* Includes unit tests for Use cases, Repository, ViewModels, API Service response.

<img src="https://github.com/wajahatkarim3/Imagine/blob/main/screenshots/Imagine-UnitTests.PNG" width="500px" />

## 📱 Download Demo on Android
Download the [APK file from here](https://github.com/wajahatkarim3/Imagine/blob/main/Imagine-App.apk?raw=true) on your Android phone and enjoy the Demo App :)

## Built With 🛠
- [Kotlin](https://kotlinlang.org/) - First class and official programming language for Android development.
- [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - For asynchronous and more..
- [Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/) - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
- [Android Architecture Components](https://developer.android.com/topic/libraries/architecture) - Collection of libraries that help you design robust, testable, and maintainable apps.
  - [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - Data objects that notify views when the underlying database changes.
  - [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Stores UI-related data that isn't destroyed on UI changes.
  - [ViewBinding](https://developer.android.com/topic/libraries/view-binding) - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views.
- [Dependency Injection](https://developer.android.com/training/dependency-injection)
  - [Hilt](https://dagger.dev/hilt) - Easier way to incorporate Dagger DI into Android apps. **This is in the [main branch](https://github.com/wajahatkarim3/Imagine)**.
  - [Dagger2](https://dagger.dev/) - Standard library to incorporate Dagger dependency injection into an Android application. **This is in a separate [dagger branch](https://github.com/wajahatkarim3/Imagine/tree/dagger-branch).**
- [Retrofit](https://square.github.io/retrofit/) - A type-safe HTTP client for Android and Java.
- [Material Components for Android](https://github.com/material-components/material-components-android) - Modular and customizable Material Design UI components for Android.
- [Gradle Kotlin DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html) - For writing Gradle build scripts using Kotlin.
- [MockK](https://mockk.io) - For Mocking and Unit Testing

## 👨 Developed By

<a href="https://twitter.com/WajahatKarim" target="_blank">
  <img src="https://avatars1.githubusercontent.com/u/8867121?s=460&v=4" width="70" align="left">
</a>

**Wajahat Karim**

[![Twitter](https://img.shields.io/badge/-twitter-grey?logo=twitter)](https://twitter.com/WajahatKarim)
[![Web](https://img.shields.io/badge/-web-grey?logo=appveyor)](https://wajahatkarim.com/)
[![Medium](https://img.shields.io/badge/-medium-grey?logo=medium)](https://medium.com/@wajahatkarim3)
[![Linkedin](https://img.shields.io/badge/-linkedin-grey?logo=linkedin)](https://www.linkedin.com/in/wajahatkarim/)