Yummies is a wonderful Android app for homemade recipes. You may quickly search by food categories or specific recipes. The app provides a detailed list of ingredients and instructions for preparation.
There is also a picture of the finished product which you can aim to match!
These are the key parameters for Yummies:
| Parameter | Value |
|---|---|
| compileSdk | 33 |
| targetSdk | 33 |
| minSdk | 21 |
| composeVersion | 1.2.1 |
| kotlinVersion | 1.6.10 |
You can clone the repository or download or download the Zip file.
Yummies is implemented using Android Clean Architecture and follows the Model-View-ViewModel (MVVM) pattern.
It features these main 3 layers:
Data Layer - features a single repository flanked by
a ROOM Database for data persistence and remote data from the API. The API provides
the remote data which is cached by the repository into the ROOM database for offline operations.
Domain Layer - this layer houses the meal and category models and the use cases which encapsulates the complex business logic for the Yummies app.
UI Layer - displays the Yummies refined data on the screen and facilitates interactions with the users. It contains the ViewModel holding the different states for the Yummies App.
It has 3 Screen destinations which use Compose Destination to manage navigation.
This screen is based on both LazyColumn and LazyRow to present categories and recipes options.
You get here by selecting a specific meal item and the app navigates you to the details screen.
You can now see an image of final cooked meals and ingredients. Pull up the bottom sheet to reveal the cooking directions
You can also view the saved items by clicking Favorites button on the main screen..
Yummies fetches its data from The Meal Db. You can find the API Documentation by following this link.
https://www.themealdb.com/api/json/v1/1/
@GET("search.php")| Parameter | Type | Description |
|---|---|---|
s |
string |
Optional. The meal keyword to search |
This interface function returns a MealsResponse DTO Object.
| Data Point | Type |
|---|---|
| id | Int |
| name | String |
| category | String |
| origin | String |
| directions | String |
| imageUrl | String |
| ingredients | List |
| units | List |
@GET("categories.php")This interface function takes no queries returns a CategoriesResponse DTO Object.
| categoryId | Int |
|---|---|
| categoryType | String |
| categoryDescription | String |
| categoryImageUrl | String |
This app is implemented using Clean Architecture MVVM Pattern. It features these other libraries mostily from Android Jetpack
- Android KTX - helps to write more concise, idiomatic Kotlin code.
- Jetpack Compose - modern toolkit for building native Android UI
- Material Design 3 - an adaptable system of guidelines, components, and tools that support the best practices of user interface design.
- Compose Destinations - used to handle all navigations and arguments passing while hiding the complex, non-type-safe and boilerplate code
- ViewModel to store and manage UI-related data in a lifecycle conscious way.
- Dagger Hilt - used for Dependency Injection.
- Coil - an image loading library for Android backed by Kotlin Coroutines
- Retrofit a REST Client for Android which makes it relatively easy to retrieve and upload JSON (or other structured data) via a REST based webservice.
- Coroutines and Kotlin Flow - used to manage the local storage i.e.
writing to and reading from the database. Coroutines help in managing background threads and reduces the need for callbacks. - Room persistence library which provides an abstraction layer over SQLite to allow for more robust database access while harnessing the full power of SQLite.
- Timber - a logger with a small, extensible API which provides utility on top of Android's normal Log class.
- Lottie Animations - provides Lightweight and scalable animations files
Do Reach Out :
Contributions to make Yummie better are always welcome!
If you are interested in seeing a particular feature implemented in this app, please open a new issue after which you can make a PR!
MIT License
Copyright (c) [2022] [Tonnie Dev]
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.