Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 3.86 KB

README.md

File metadata and controls

81 lines (55 loc) · 3.86 KB
Raw

DogBreed App

This project showcases modern Android app development with clear architectural guidance. It includes popular tools, libraries, and testing frameworks to promote a scalable and maintainable architecture.

The app is modularised by both layer and feature

Resource: https://developer.android.com/topic/modularization/patterns

Getting Started

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

Environment requirement

To build this project, you require:

  • From Android Studio Giraffe upward
  • Gradle 8.0
  • Kotlin 1.9.20
  • Android Gradle Plugin 8.1.0

Features 🎨

The dogBreed App is a simple application that presents a list of all dog breeds, their subbreeds and you're able to add a breed as a favorite. This data is fetched from https://dog.ceo/dog-api/ API

The app has a few screens located in multiple feature modules:

  • All breeds screen - displays list of all dog breeds
  • Breed details screen - displays information about the selected breed
  • Subbreed screen - displays images of a dog subbreed
  • Favourites screen - display list of favorite breeds

image showing all breeds image showing breed details image showing subbreeds image showing all favorite breeds

Tech Stack

  • Compose - modern toolkit for building native Android UI

  • ViewModel - Presenter for persisting view state across config changes

  • Coroutine - recommended way to execute asynchronous code, main safe!, and eliminates call back hell code

  • Room - provides abstraction layer over SQLite

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

  • Kotlin Serialization - Kotlin JSON Parser

  • Coil - load and display image url

  • Turbine - testing kotlin flow

  • mockk - mocking library for kotlin used in test

  • Hilt - for dependency injection

License

MIT License

Copyright (c) 2020 Tobiloba Oyelekan

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.