/AnimeArch

Primary LanguageKotlin

AnimeArch


An anime info app for teaching how to use Jetpack Compose (State, Navigation, Animation etc..) with Clean Architecture and shows how to write Unit & Ui test


License API Profile

Screeshots

Tech stack & Open-source libraries

  • Minimum SDK level 21
  • 100% Kotlin based + Coroutines and Flow
  • Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
    • A single-activity architecture, using the Compose Navigation to manage composable transactions.
    • Lifecycle - perform an action when lifecycle state changes
    • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
    • UseCases - Located domain layer that sits between the UI layer and the data layer.
    • Repository - Located in data layer that contains application data and business logic.
  • Jetpack Compose - is Android’s recommended modern toolkit for building native UI. It simplifies and accelerates UI development on Android. Quickly bring your app to life with less code, powerful tools, and intuitive Kotlin APIs
  • Android Hilt - Dependency Injection Library
  • Retrofit A type-safe HTTP client for Android and Java
  • OkHttp An HTTP client that efficiently make network requests
  • Coil Compose An image loading library for Android backed by Kotlin Coroutines
  • Testing
    • Mockito A mocking framework that tastes really good. It lets you write beautiful tests with a clean & simple API
    • MockWebServer A scriptable web server for testing HTTP clients
    • Truth A library for performing assertions in tests
    • Turbine A small testing library for kotlinx.coroutines Flow
  • Material Design 3 is the latest version of Google’s open-source design system.

Package Structure

com.halilozcan.animearch # Root Package
.
├── data                # Data layer
│   ├── api             # AnimeApi     
│   ├── dto             # Data transfer objects for remote response
│   ├── repository      # Anime repository
│   ├── source          # Remote or local data sources(for now remote only)
|
├── di                  # Dependency Injection             
│   ├── coroutine       # Coroutine Dispatcher Module      
│   │── mapper          # AnimeMapper Module
│   │── network         # Network Modu(okHttp & Retrofit) & SourceModule
│   │── repository      # Repository Module
|
├── domain              # Domain Layer(UseCases) 
|   ├── entity          # Domain entities
|   ├── mapper          # Domain mappers
|   ├── usecase         # Anime usecases
|
├── ui                  # Activity / ViewModel/ Composables (Ui) layer
│   ├── detail          # DetailUiMapper, ViewModel and detail Composables
│   ├── home            # HomeUiMapper, ViewModel and detail Composables
|   ├── theme           # Colors, typography and theme options

Architecture

This app uses MVVM (Model View View-Model) architecture

Find this repository useful? ❤️

follow me for my next creations! 🤩

License

Designed and developed by 2022 halilozcan (Halil ÖZCAN)

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.