Giter Site home page Giter Site logo

recipe-app's Introduction

Introduction

Recipe app created to put in practice my learnings of the book Jetpack compose by tutorial - Kodeco

Screenshots

Home & Detail Map
map map

Requirements

The application must contain the following screens:

  • Home Screen: Lists available recipes and a search bar.
  • Detail Screen: Displays detailed information about a selected recipe.
  • Map Screen: Shows the location of the selected recipe.

Solution

The app makes use of Clean Architecture to separate the application's logic into layers. The presentation layer displays the information to the user, the domain layer manages business logic, and the data layer handles data access.

The MVVM pattern separates the view logic from the application logic. The view presents information to the user, and the application logic provides information to the view.

Flows are used to manage the request of the data outside the main thread

The proposal takes advantage of Compose to build the user interface.

How to run

  • Gradle JDK: Java 17 should be used Build > Execution > Deployment > Build tools > Gradle)

Good Practices

The application implements the Android version catalog to ensure compatibility with the latest Android versions.

Gradle KTS is used to write the application's build script.

Automated Tests

The application includes automated tests for verifying the application's logic.

Areas for Improvement

The application could be enhanced in the following areas:

  • Abstraction of the HTTP client in ktorClientImpl.
  • Addition of an interceptor to detect network status changes before making a request.
  • Unit tests for ktorClientImpl.
  • Implementation of database persistence.
  • Interface segregation in LocalDataSource.
  • Improvement of test object creation with a factory method.

Used Libraries

The application utilizes the following libraries:

  • ktor for backend communication.
  • coil for image loading.
  • navigation for screen navigation.
  • maps for displaying maps.
  • dagger for dependency injection.
  • turbine for debugging flows.
  • coroutines for asynchronous programming.
  • kotest for automated testing.

UX/UI

The UX/UI was inspired by the following design hosted by Figma and all the rights belong to its creator, this app does not have the intention to be published on any Marketplace Store.

recipe-app's People

Contributors

djangolc avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.