Ezike/StarWarsSearch-MVI

Hey there 👋🏼👋🏼👋🏼

This project contains an implementation of the Componentization idea as shown by the UI Engineering team at Netflix.

Resources: blog, repo, talk

Features

• Clean Architecture with MVI (Uni-directional data flow)
• View components
• Kotlin Coroutines with Flow
• Dagger Hilt
• Kotlin Gradle DSL
• GitHub actions for CI

Prerequisite

To build this project, you require:

• Android Studio Flamingo
• Gradle 7.5
• Kotlin 1.7.20
• Android Gradle Plugin 8.0.0-alpha02

Run the following command in the root of the project to setup your Android Studio:

./setup.sh

This script will configure ktlint

Screenshots

Libraries

• Viewmodel - Presenter for persisting view state across config changes

• FlowBinding - converts traditional view click listeners and call backs to Kotlin flow

• Room - Provides abstraction layer over SQLite

• Retrofit - type safe http client and supports coroutines out of the box.

• Moshi - JSON Parser,used to parse requests on the data layer for Entities and understands Kotlin non-nullable and default parameters

• okhttp-logging-interceptor - logs HTTP request and response data.

• kotlinx.coroutines - Library Support for coroutines,provides runBlocking coroutine builder used in tests

• Truth - Assertions Library,provides readability as far as assertions are concerned

• MockWebServer - web server for testing HTTP clients ,verify requests and responses on the star wars api with the retrofit client.

• Robolectric - Unit test on android framework.

• Espresso - Test framework to write UI Tests

• Dagger Hilt - handles dependency injection

  License

Copyright 2020-2021 Ezike Tobenna

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.