RickAndMorty

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 70 Open GitHub ↗

Modern Architecture sample with MVI using SqlDelight & Ktor with modularization 📦

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Rick & Morty App ✨

This project demonstrates **Modern App Architecture** best practices in a **Multi-Module** Android application using **MVI** architecture pattern. This app is made entirely in Kotlin and consumes pure Kotlin libraries to manage application data **(SqlDelight, Ktor)** and UI **(Jetpack Compose)**. Dependency Injection is managed via **Koin**.

## 📷 Screenshots (Light & Dark Color Schemes)

## Dynamic Colors - Android 12+
Dynamic Color enables users to personalize their devices to align tonally with the color scheme of their personal wallpaper or through a selected color in the wallpaper picker. You can read more about Dynamic Colors [here](https://developer.android.com/develop/ui/views/theming/dynamic-colors).

https://github.com/shahzadansari/RickAndMorty/assets/43310446/e3a3fa5a-0a6f-40f8-b81d-283441945c2f

## 📐 Architecture Overview

The app architecture has three layers: a [data layer](https://developer.android.com/jetpack/guide/data-layer), a [domain layer](https://developer.android.com/jetpack/guide/domain-layer) and a [UI layer](https://developer.android.com/jetpack/guide/ui-layer). The architecture follows a reactive programming model with [unidirectional data flow](https://developer.android.com/jetpack/guide/ui-layer#udf). With the data layer at the bottom, the key concepts are:
*   Higher layers react to changes in lower layers.
*   Events flow down.
*   Data flows up.

The data flow is achieved using streams, implemented using [Kotlin Flows](https://developer.android.com/kotlin/flow).

### UI Layer
The UI layer is the pipeline that converts application data changes to a form that the UI can present and then displays it. The state is managed using a [Unidirectional Data Flow (UDF)](https://developer.android.com/topic/architecture/ui-layer#udf) which aligns with the  **MVI (Model View Intent)** architecture pattern's **event-based** nature.

### Data Layer
While the UI layer contains UI-related state and UI logic, the data layer contains application data and business logic. The business logic is what gives value to your app—it's made of real-world business rules that determine how application data must be created, stored, and changed. The data layer is implemented as an offline-first source of app data and business logic. It is the [source of truth](https://developer.android.com/topic/architecture#single-source-of-truth) for all data in the app.

### Domain Layer
The domain layer is an optional layer that sits between the UI layer and the data layer. The domain layer is responsible for encapsulating complex business logic, or simple business logic that is reused by multiple ViewModels. This layer contains Usecases/Interactors which interact with data sources inside Data Layer.

---

**Rick & Morty App** is an [offline-first app](https://developer.android.com/topic/architecture/data-layer/offline-first#:~:text=An%20offline%2Dfirst%20app%20is%20an%20app%20that%20is%20able%20to%20perform%20all%2C%20or%20a%20critical%20subset%20of%20its%20core%20functionality%20without%20access%20to%20the%20internet.%20That%20is%2C%20it%20can%20perform%20some%20or%20all%20of%20its%20business%20logic%20offline.) and the app flow works as:
1. Characters are fetched from [Rick & Morty API](https://rickandmortyapi.com/) using Ktor-client for Android.
2. Characters are then stored in a SqlDelight Database. Our database inside Data layer is our single source of truth.
3. The stored characters in cache are then requested by the Usecase in our domain layer.
4. Characters from the cache are then exposed to the UI layer where they can be accessed as observable data streams i.e. Kotlin Flows.

This app has two screens:
1. **Characters List Screen**
2. **Character Details Screen**

## Characters List Screen Architecture

## Character Details Screen Architecture

## 📦 Modularization Overview
We have following modules in our project. Among these modules, we have **Android Application** module, **Android Library** modules & pure **Kotlin Library** modules. I have preferred using pure Kotlin libraries in domain & data layers as they can easily be reused in Kotlin Multiplatform projects. Therefore, **SqlDelight** is preferred over **Room** & **Ktor client** is used instead of **Retrofit**.

| Module name                                 | Type                   | Description                                                                                                                          |
| -------------                               | -------------          | -------------                                                                                                                        |
| app                                         | Android Application    | Brings everything together required for the app to function correctly. This includes UI scaffolding and navigation.                  |
| core                                        | Kotlin Library    | Core business models and classes (such as DataState/Result wrapper classes) that are used by multiple modules.                       |
| character-datasource                        | Kotlin Library    | Contains data-sources and private models such as `CharacterDto` & `CharacterEntity` (network and cache) for the characters module.   |
| character-domain                            | Kotlin Library    | Domain models and classes for the characters module i.e. data class `Character`                                                      |
| character-interactors                       | Kotlin Library    | Use-cases for the characters Module.                                                                                                 |
| ui-character-list                           | Android Library        | UI components for the CharactersList screen.                                                                                         |
| ui-character-details                        | Android Library        | UI components for the CharacterDetails screen.                                                                                       |
| components                                  | Android Library        | Common Composables.                                                                                                                  ||

## 🗃️ Tech Stack
* [100% Kotlin](https://kotlinlang.org/)
    + [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - perform background operations
    + [Kotlin Flow](https://kotlinlang.org/docs/flow.html) - data flow across all app layers, including views
    + [Kotlin Symbol Processing](https://kotlinlang.org/docs/ksp-overview.html) - enable compiler plugins
    + [Kotlin Serialization](https://kotlinlang.org/docs/serialization.html) - parse [JSON](https://www.json.org/json-en.html)
  * [Ktor client](https://ktor.io/docs/getting-started-ktor-client-multiplatform-mobile.html) - Networking
* [Jetpack](https://developer.android.com/jetpack)
    * [Compose](https://developer.android.com/jetpack/compose) - modern, native UI kit
    * [Compose Navigation](https://developer.android.com/jetpack/compose/navigation) - in-app navigation
* [SqlDelight](https://cashapp.github.io/sqldelight/1.5.4/) - For local cache
* [Koin](https://insert-koin.io/) - dependency injection (dependency retrieval)
* [Coil](https://github.com/coil-kt/coil) - image loading library
* Modern Architecture
  * MVI Architecture Pattern
  * [Android Architecture components](https://developer.android.com/topic/libraries/architecture)
    ([ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel),
    [Kotlin Flows](https://kotlinlang.org/docs/flow.html),
    [Navigation](https://developer.android.com/jetpack/androidx/releases/navigation))
  * [Android KTX](https://developer.android.com/kotlin/ktx) - Jetpack Kotlin extensions
* UI
  * Reactive UI
  * [Jetpack Compose](https://developer.android.com/jetpack/compose) - modern, native UI kit
  * [Material Design 3](https://m3.material.io/) - application design system providing UI components
  * Theme selection
    * [Dark Theme](https://material.io/develop/android/theming/dark) - dark theme for the app (Android 10+)
    * [Dynamic Theming](https://m3.material.io/styles/color/dynamic-color/overview) - use generated, wallpaper-based theme (Android 12+)
    * Theme generated via [Material Theme Builder](https://m3.material.io/theme-builder)
* Gradle dependencies are managed using the [Version Catalog](https://developer.android.com/build/migrate-to-catalogs) approach in [`libs.versions.toml`](/gradle/libs.versions.toml) file.

## Get Started

There are a few ways to open this project.

### Android Studio

1. `Android Studio` -> `File` -> `New` -> `From Version control` -> `Git`
2. Enter `https://github.com/shahzadansari/RickAndMorty.git` into URL field and press `Clone` button

### Command-line And Android Studio

1. Run `git clone https://github.com/shahzadansari/RickAndMorty.git` command to clone the project
2. Open `Android Studio` and select `File | Open...` from the menu. Select the cloned directory and press `Open` button

## ⭐ Find this repository useful? Leave a Star
Add this repository to your watchlist to get notified about the latest updates in the repository.

## ⏭️ Future Work
- v1.4 Unit Tests
- v1.5 UI Tests
- v1.6 Pagination

## 🤝 Want to Contribute?
All contributions are welcomed. This project is still in development. If you encounter any problems, please create an issue [here](https://github.com/shahzadansari/RickAndMorty/issues) & if you want to contribute to this project, PRs are welcomed! 🙂

## 👨‍💻 Developed By

**Shahzad Ansari**

[![Twitter](https://img.shields.io/badge/-twitter-grey?logo=twitter)](https://x.com/Shahzad_Ansari3)
[![Linkedin](https://img.shields.io/badge/-linkedin-grey?logo=linkedin)](https://www.linkedin.com/in/shahzadansari6/)

RickAndMorty

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

RickAndMorty

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README