Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fauxtix/mauirecipesapp
.Net 8 MAUI app to display recipes, by using the Spoonacular Api. It allows the selection of various regions in the world
https://github.com/fauxtix/mauirecipesapp
c-sharp http-requests maui-app mvvm-architecture
Last synced: 14 days ago
JSON representation
.Net 8 MAUI app to display recipes, by using the Spoonacular Api. It allows the selection of various regions in the world
- Host: GitHub
- URL: https://github.com/fauxtix/mauirecipesapp
- Owner: fauxtix
- License: mit
- Created: 2024-10-29T16:52:48.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-12-11T16:19:48.000Z (22 days ago)
- Last Synced: 2024-12-11T16:41:39.741Z (22 days ago)
- Topics: c-sharp, http-requests, maui-app, mvvm-architecture
- Language: C#
- Homepage:
- Size: 1.13 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# **Cooking Recipes - Mobile Application**
- [Portuguese](./Portuguese.MD)
This application allows users to search, view, and store cooking recipes locally, using the Spoonacular API. Recipes can be filtered by region and ingredient, with features for local caching and date expiration.
The users may also view the recipes marked as favorites, and the previously searched recipes by Region and/or Ingredient (see the screenshots).
When viewing a recipe, there is the possibility to mark it as a Favorite; the app has a separated option (tab bar) to list and consult them individually.
## **Features**
- **Recipe Search**:
- Allows searching for recipes by region and ingredient. Users can choose from different regions of the world (e.g., Italian, American, Japanese, etc.);
- Search results can be filtered by the number of recipes (10, 20, or 30 recipes);
- **Other options**
- List of the last searches saved (cached) in the database;
- List of the last recipes viewed (cached);
- List of the best rated (popular) recipes, according to the search criteria.
- **Local Storage**:
- Recipes already researched, are stored locally using an SQLite database.
This feature is used to provide faster, optimized responses to the user (offline, with no internet access required).
- **Choose Number of Recipes**:
- Users can select the number of recipes to load, with options for 10, 20, or 30 recipes.
- **Search Interface**:
- The text search field and the dropdown provided, allows users to search by region and/or ingredient, by clicking a **search** button.
- **Recipe Details View**:
- By selecting a recipe, users can view detailed information, including ingredients, preparation instructions, and additional information about the recipe.
They also can mark the recipe as Favorite.
- **Favorites**
- The app allows the user to mark a recipe as a favorite; there is a dedicated option (tab) to list and view recipe details
- **Notifications and Alerts**:
- The app shows notifications and alerts to inform the user about the status of loaded recipes (e.g., "Recipes loaded successfully", "Recipes loaded from database", "Error loading recipes", etc.).
## **Technologies Used**
- **C#**
- **.NET MAUI** - Framework for building cross-platform mobile applications for Android, iOS, MacOS, and Windows.
- **SQLite** - Local database for storing recipes.
- **Spoonacular API** - External API for fetching information on cooking recipes.
- **CommunityToolkit.Maui/MVVM** - Libraries to simplify mobile app development with MAUI.
## **How to Run Locally**
1. Clone the Repo => git clone https://github.com/fauxtix/MauiRecipesApp
2. Get a free API key from https://spoonacular.com/food-api/console
3. Open the project in Visual Studio or Visual Studio Code.
4. Go to SpoonacularService.cs class file in Services/Implementations
5. Change this line:
~~~C#
// change the _apiKey you grabbed from Spoonacular Website
private readonly string? _apiKey = "mykey";
~~~
6. Restore the packages (Rebuild the solution)
7. Run the app on an emulator or real device.
The SQLite database will be automatically created in the app's data directory.
## **Future Features**
- Implement functionality to sort recipes by different criteria such as preparation time, popularity, etc.
- UI improvements, including additional search filters.
## Educational Purpose
This project was developed as a way of learning and exploring the capabilities of .Net MAUI.
The main objective is to get to know and experiment its various components and standards.
Additionally, the Spoonacular Api was incorporated to broaden the scope of exploration, allowing for experimentation with accessing external Apis into the application.
In the MauiRecipesApp, the Spoonacular Api was used to get recipe data from various regions of the world.
### Learning Objectives
- Gain familiarity with .Net MAUI components and their usage;
- Understand how to integrate external APIs into MAUI apps;
- Learn the MVVM architectural pattern, by using Maui.Community.Toolkit;
- Explore data visualization and presentation techniques.
## Work in Progress
This project is currently a work in progress. While it provides basic functionality for recipe search and access to the Spoonacular Api, it is expected to evolve over time.
# Screenshots
### 🌟 Contributing
Contributions are welcome! If you have suggestions for new features or improvements, feel free to submit a pull request or open an issue on GitHub.
1. Fork the project (https://github.com/fauxtix/MauiRecipesApp/fork)
2. Create a branch for your modification (git checkout -b fauxtix/MauiRecipesApp)
3. Commit (git commit -am 'Add some fooBar')
4. Push (git push origin fauxtix/MauiRecipesApp)
5. Create a new Pull Request
When contributing code, please follow the existing code style and submit a pull request with your changes.
### Disclaimer
This project is a work in progress and may undergo changes and updates without prior notice. It is being developed for educational purposes and may include experimental features and components.
It does not serve any commercial or production purposes.
## ⚖ License
The MauiRecipes project is licensed under the [MIT License](./LICENSE.md).
## 📞 Contact
If you have any questions or need further assistance, you can reach out to the project maintainer:
- 👨💻 Maintainer: Fausto Luís
- ✉ Email: [email protected]
Feel free to contact me with any feedback or inquiries.