An open API service indexing awesome lists of open source software.

https://github.com/rh9891/squaremeal

A mobile-responsive, recipe search application that utilizes the TheMealDB API while featuring connecting to API with fetch() and DOM manipulation.
https://github.com/rh9891/squaremeal

dom-manipulation fetch-api mealdb-api vanilla-javascript

Last synced: 3 months ago
JSON representation

A mobile-responsive, recipe search application that utilizes the TheMealDB API while featuring connecting to API with fetch() and DOM manipulation.

Awesome Lists containing this project

README

        

# Square Meal

![MIT License](https://img.shields.io/badge/License-MIT-yellow.svg)
![JavaScript](https://img.shields.io/badge/JavaScript-ES6+-f7df1e?logo=javascript&logoColor=black)
![API](https://img.shields.io/badge/API-TheMealDB-ff6f00?logo=api&logoColor=white)
![Responsive](https://img.shields.io/badge/Responsive-Mobile--First-blue)

## Table of Contents
- [Description](#description)
- [User Story](#user-story)
- [Features of the Application](#features-of-the-application)
- [Preview of Square Meal](#preview-of-square-meal)
- [Links](#links)
- [Built Using](#built-using)
- [License](#license)
- [Contributing](#contributing)
- [Questions](#questions)

## Description

Square Meal is a mobile-responsive, recipe search application. The application utilizes the TheMealDB API to access over 250 meals and recipes from around the world. From succulent Honey Teriyaki Salmon to creamy Prawn and Fennel Bisque, the mouth-watering possibilities for one's next meal idea are unending!

## User Story

```
AS A user
I WANT to search a meal name to find matching recipes
SO THAT I can use the provided instructions to make the meal.
```

## Features of the Application

```
GIVEN a recipe search application
WHEN I input the meal name into the search bar
THEN I am presented with pictures of recipes with matching names on the DOM.

WHEN I hover over the picture of the searched meal
THEN the name of the meal will be displayed.

WHEN I click on the picture of the searched meal
THEN further details about that meal will be displayed (category, cuisine, instructions, etc.).

WHEN I click on the "random" button (adjacent to the search bar)
THEN the application will fetch and display a random meal.
```

## Preview of the Square Meal

![Square Meal Landing Page](assets/images/squareMealLandingPage.png)

![Square Meal Search Results Page](assets/images/squareMealSearchResultsPage.png)

![Square Meal Recipe Page](assets/images/squareMealRecipePage.png)

![Square Meal Functionality](https://github.com/user-attachments/assets/cda73a7d-c22d-4a44-9e0f-96f75be266f0)

## Links

- [Deployed Application](https://square-meal.netlify.app)

- [Github Repository](https://github.com/rh9891/SquareMeal)

## Built Using

Listed below are the frameworks, libraries, and guides that made building this application possible:

- [JavaScript](https://www.w3schools.com/js/default.asp)
- [JavaScript Fetch API](https://www.w3schools.com/js/js_api_fetch.asp)
- [Snackbar](https://www.w3schools.com/howto/howto_js_snackbar.asp)
- [Traversy Media Tutorials](https://www.traversymedia.com)

## License

The MIT License (MIT)

Copyright (c) 2021-2024 Romie Hecdivert

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.

## Contributing

If you would like to contribute to this repository, please contact me via [Github](https://github.com/rh9891).

## Questions

If you have any questions, comments, or issues regarding this application, please do not hesitate to contact me via [Github](https://github.com/rh9891).