Yummy
is a dynamic food discovery platform that helps users explore various recipes based on ingredients, categories, and regions.- This platform is a
dynamic website
that offersreal-time food discovery
, including recipe search, ingredient-based suggestions, and more. - The website is designed with a clean and
user-friendly interface
, making it easy for food enthusiasts to find recipes, explore categories, and stay up to date with newmeal ideas
. - Below are the main sections of the websiteπ:
- Check out the live demo of the project at
Yummy_Platform
.
1. Header:
- Site Title: Displays "Yummy" with a relevant logo.
- Search Bar: Allows users to search for recipes or ingredients by name.
- Navigation Links: Includes links to various sections such as categories, areas, and ingredients.
2. Recipe Search Section:
- Search Results: Displays recipes based on search terms, such as ingredients, cuisine, or meal type.
- Recipe Cards: Each card shows the dish name, image, and a short description.
3. Categories Section:
- Category Cards: Displays various categories like "Breakfast," "Lunch," "Dinner," "Desserts," etc.
- Explore by Category: Users can filter recipes based on meal categories.
4. Area-Based Section:
- Region-Specific Recipes: Recipes categorized by region or cuisine (e.g., Italian, Mexican, Asian).
- Region Cards: Displays food from specific areas to help users discover new flavors.
5. Ingredients Section:
- Ingredients Search: Allows users to search for recipes based on the ingredients they have at home.
- Recipe Suggestions: Displays recipe suggestions based on the entered ingredients.
6. Contact Us Section:
- Contact Form: Users can reach out to the Yummy team for feedback, questions, or partnership inquiries.
7. External Resources:
- Toggle Dark/Light Theme: Users can switch between dark and light themes for an enhanced browsing experience.
- Responsive Design: The navigation bar is optimized for mobile devices and will adjust automatically.
- Smooth Scrolling: When clicking on a section link, the page will smoothly scroll to the selected section.
- Hover Effects on Icons: Hover Effects on Icons: Smooth animations happen when you hover over the icons in the side.
HTML5:
Provides the structure and content of the web pages.
CSS3:
Used for styling and layout, including frameworks like Bootstrap and Font Awesome for responsive design and iconography.
JavaScript:
Implements interactive features like the theme switcher, search functionality, and dynamic content loading.
jQuery:
Utilized for simplifying DOM manipulation and event handling
APIs:
For fetching data related to recipes, ingredients, and categories in real-time
JSON:
Data format used to handle information retrieved from APIs.
The application uses the following APIs:
Free Meal API:
Retrieves recipes, ingredients, and meal details. API endpoint: https://www.themealdb.com/api.php
We welcome contributions
to Yummy - Food Discovery Platform ! Hereβs how you can help:
-
Fork the repository - Click the "Fork" button at the top right of the repository page.
-
Clone your fork - Use the command:
git clone https://github.com/OmarrSakr/Yummy-Site.git
π yummy/
β
βββ π *assets/*
β βββ πΌ *Imgs/* # Local images for recipes and UI
βββ π¨ *css/*
β βββ π *style.css* # Main stylesheet
β βββ π *all.min.css* # Font Awesome Library
β βββ bootstrap.min.css # Bootstrap CSS for layout and styling
βββ π§βπ» *js/*
β βββ β *app.js* # Main logic for fetching recipe data
β βββ β *jsconfig.json* # To make vsCode autocomplete jQuery
β βββ bootstrap.bundle.min.js # Bootstrap JavaScript bundle
βββ π *index.html* # Main HTML file
βββ π *README.md* # Documentation
1- Interactive Features
:
- Recipe Rating & Reviews: Add functionality for users to rate and review meals. This could involve integrating a simple star rating system and a comment section.
- Meal Customization: Allow users to customize their meal orders or explore variations based on ingredients or category preferences. This could be implemented with checkboxes or dynamic filtering.
2- Advanced Features
:
- Meal Subscription or Newsletter: Add a subscription feature where users can sign up to get new recipes delivered to their inbox or get notifications about new meal additions.
- Social Sharing Options: Improve social sharing options for meals. Make it easy for users to share their favorite meals on platforms like Facebook, Instagram, or Twitter directly from the website.
3- Accessibility
:
- Keyboard Navigation: Improve accessibility by ensuring users can navigate through the site using just the keyboard, especially for the menu and form elements.
- Alt Text for Images: Ensure all images have descriptive alt text for better screen reader compatibility.
By implementing some of these improvements, you can enhance both the user experience and performance of the website, making it more engaging and easier to navigate.
- This project is a
Dynamic website
. - API Keys: Ensure that you have valid API keys for accessing
food-related data
. You can obtain these from the respective service providers and should store them securely. - Internet Connection: The app requires an active internet connection for fetching live data.
- Device Compatibility: The app is designed to be responsive and works best on modern browsers. It is recommended to test on different devices for optimal performance.
- Cache Management: If you experience issues with data loading, try clearing your browser's cache or refreshing the page.
- πͺ
*Feedback*
: If you encounter any bugs or have suggestions for improvements,π¨please reach out via
the contact information provided inthe README
or through the issuetracker
on GitHub.