othiagosouto / marvelpoc

Marvel Characters

Marvel characters it's an app built to present info related to marvel characters available at Marvel website.

Current objective

• Refactor the app to use compose
• Replace the directs calls to MarvelApi to use a BFF as middle
• Refactor the koin usage to Hilt
• Create design system structure

Goals

• Study Kotlin and apply some architecture concepts in this project.

Architecture

This project is built using a MVVM architecture with multi module structure. The diagram below represents the structure of the modules.

Stack

• MVVM Architecture without databinding
• Coroutines
• Kotlin
• Room
• Koin
• Ktor
• Paging
• Github actions

Testing

• AndroidX Test
• Mockk
• Junit
• Espresso
• Robot Pattern
• Orchestrator

Quick Start

Run project

You need to follow the steps described steps in order to the application doesn't crash during runtime.

• This app uses a private BFF hosted on digital ocean-
• Checkout the code and build the application

Running tests

• Instrumented: ./gradlew connectedAndroidTest
• Unit: ./gradlew test

Contact

Email: [email protected]

Twitter

Medium

marvelpoc's Issues

Use gradle catalog

Use GithubActions to run instrumented tests

Improve codacy grade

The goal of this issue is to fix the codacy issues and improving the grade.

Create search view

Implement search view

Create Favorites Mode

app should load favorites characters stored inside a different tab that would be available at Home fragment

Create a README.MD

You should create a file presenting some instructions like:

1. Running the app
2. Running tests
3. CI Integration
4. Architecture Info

Refactor Project Modules

Refactor the structure of the modules

Support code coverage

This ticket aims to add code coverage support and merge all reports and create a unified test report.

Create Splash Screen

Create a splash screen and present some animation using Lottie library from AirBnb

Use navigation Library

The app should use the navigation library to navigate from Home or favorites to Character Details

Refactor to compose

Refactor everything to compose

Config the project CI

The goal of this task is to choose and set up a CI for this project

Project UI for home view

The goal of this task is to create the UI for this first interaction (Home)

Remove mockk usage

Replace mockk usage with fakes/real objects.

Create characters tab

app should load characters available at home fragment

Code shrinking - Use R8

Documentation: https://developer.android.com/studio/build/shrink-code

Create Details Screen

The app should have a screen to load info about the chosen character.

Must have:

1. Favorite/Unfavorite Feature
2. Description
3. Picutre

Bonus:
Fetch Series and create a horizontal list presenting them.

Publish the App on play store

Publish the android app on the playstore.

Project UI for Characters Details Views

Should create a UI to present the details of the chosen characters.

Use UiModels instead of domain for UI

Create Credentials on Marvel Developer Api

The goal of this card is to create an account on Marvel developer API

Create Snapshot Tests

Create SnapshotTests using Facebook or Shot plugin to validate the UI of the project.

Refactor gradle structure

The Gradle scripts have a lot of duplicated code, so you should refactor that in some way that we don't have any duplicated code anymore.

Move from koin to Hilt

Refactor project to use Hilt instead of koin.

Apply static analysis tools

Apply static analysis tools and fix the issues that you will found.

Some tools:

• Detekt
• Lint

Setup compose

The goal of this issue is to set up the project to work with jetpack compose.

Setup gradle dependencies

The goal of this task is to config the dependencies.gradle and remove all hardcoded Gradle content from build.gradle(app)

Create home pagination

The Home tab should have infinite pagination using the android jetpack pagination and fetching data from the marvel webservice.

Using an offset of 30 items.

Create Favorites pagination

The favorites tab should have infinite pagination using the android jetpack pagination and room.

Using an offset of 30 items.