Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hamza94max authored Jul 8, 2023
1 parent 90bd7de commit 0903f81
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Foody
An android app that use [Food Api](https://www.themealdb.com/api.php) to display different categories of food

## Architecture
The architecture of this application relies and complies with the following points below:
- __Clean Architecture__,: into 3 layers ui, data, domain
- __A single-activity architecture__, using the Navigation Components to manage fragment operations.
- __Pattern Model-View-ViewModel (MVVM)__ which facilitates a separation of development of the graphical user interface.
- __Android architecture components__ which help to keep the application robust, testable, and maintainable.

![Capture](https://github.com/hamza94max/Foody/assets/54688005/d2f03de3-fee0-464d-a789-6c268f5d1dc8)


## ScreenShots

<p float = "left">
<img src = "https://github.com/hamza94max/Foody/assets/54688005/b1e0adbe-6d48-4fc0-a4e8-bc60d0e3a4b5" width = "35%">
<img src = "https://github.com/hamza94max/Foody/assets/54688005/dc0021f7-9964-49a8-b24c-960957072c51" width = "35%">
<img src = "https://github.com/hamza94max/Foody/assets/54688005/1c4850f7-b3f0-4216-b603-488bbd5f6349" width = "35%">
<img src = "https://github.com/hamza94max/Foody/assets/54688005/593d05f7-2fc1-479f-b1eb-a1ff0eaab236" width = "35%">
<img src = "https://github.com/hamza94max/Foody/assets/54688005/e064bef2-9538-416a-a29c-e734300cb79a" width = "35%">
<img src = "https://github.com/hamza94max/Foody/assets/54688005/d62525ae-2f1d-483f-9a98-9ff31803e514" width = "35%">

<p/>

# Languages and Tools
* [Kotlin](https://kotlinlang.org/) - official programming language for Android development .
* [Hilt](https://developer.android.com/training/dependency-injection/hilt-android) - dependency injection library .
* [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - for asynchronous programming .
* [Android Architecture Components](https://developer.android.com/topic/libraries/architecture) - Collection of libraries that help you design robust, testable, and maintainable apps.
- [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - Data objects that notify views when the underlying database changes.
- [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Stores UI-related data that isn't destroyed on UI changes.
- [Room](https://developer.android.com/topic/libraries/architecture/room) - Access your app's SQLite database with in-app objects and compile-time checks.
- [Navigation Components](https://developer.android.com/guide/navigation) - the interactions that allow users to navigate across, into, and back out from the different pieces of content within your app
* [Fragment](https://developer.android.com/guide/components/fragments)
* [View Binding](https://developer.android.com/topic/libraries/view-binding) - more easily write code that interacts with views.
* [LeakCanary](https://square.github.io/leakcanary) - memory leak detection library for Android.
* [detekt](https://github.com/detekt/detekt) - Static code analysis for Kotlin.



# How to install and run the project.
You can download Apk from **release** section



0 comments on commit 0903f81

Please sign in to comment.