https://github.com/kanzatahreem/the-mealdb

Web app build on an external API called as MealDB, and an Involvement API which is used to record the user interactions including likes, and comments.
https://github.com/kanzatahreem/the-mealdb

api api-documentation asynchronous-programming callback css es6-modules git-conflicts gitflow github-projects group-project html javascript-es6 jest-tests json kanban-board mealdb-api meals-recipes promises seafood unittest

Last synced: 26 days ago
JSON representation

Web app build on an external API called as MealDB, and an Involvement API which is used to record the user interactions including likes, and comments.

• Host: GitHub
• URL: https://github.com/kanzatahreem/the-mealdb
• Owner: KanzaTahreem
• License: mit
• Created: 2022-10-17T20:08:58.000Z (about 2 years ago)
• Default Branch: dev
• Last Pushed: 2022-12-01T10:45:59.000Z (almost 2 years ago)
• Last Synced: 2023-05-05T00:51:27.573Z (over 1 year ago)
• Topics: api, api-documentation, asynchronous-programming, callback, css, es6-modules, git-conflicts, gitflow, github-projects, group-project, html, javascript-es6, jest-tests, json, kanban-board, mealdb-api, meals-recipes, promises, seafood, unittest
• Language: JavaScript
• Homepage: https://kanzatahreem.github.io/The-MealDB/
• Size: 4.22 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![](https://img.shields.io/badge/Microverse-blueviolet)

# The MealDB - API based webapp

> The JavaScript capstone project is build on [MealDB](www.themealdb.com/api/json/v1/1/filter.php?c=Seafood), an external API, and an [Involvement API](https://www.notion.so/Involvement-API-869e60b5ad104603aa6db59e08150270) which is used to record the user interactions including likes, and comments. The project covers the following mentioned points

- _The main page shows a list or a collection of meals (retrieved from an ­external API) that you can like._

- _A popup window with more data about an item that you can use to comment on the different meals and also see a list of comments._

- _In the pop-up window you can see the main ingredients, needed for each recipe, a procedure to follow for the preparation of each meal._

- _The popup window consists of two buttons, one that connects to a YouTube video explaining step-by-step of each recipe, and another one that links to official website._

- _The application shows the number of likes and comments for each meals._

  ­

## Built With

- HTML & CSS

- Bootstrap

- JavaScript (ES6)

- Webpack

- Jest Testing Library

- [MealDB API](www.themealdb.com/api/json/v1/1/filter.php?c=Seafood)

- [Linters](https://github.com/microverseinc/linters-config/tree/master/html-css-js)

## Live Demo

Live at [MealDB](https://kanzatahreem.github.io/The-MealDB/)

## Video Description

View [video presentaton](https://drive.google.com/file/d/15EJIl7FRh6fjecDbtRE1uvWspvTicPxb/view?usp=sharing)

## Getting Started

### Prerequisites

- node.js (10.13.0 (LTS))

- git

### Setup

To get a local copy, follow the steps below:

1. Open your terminal

2. Navigate to the directory where you want to clone the project.

3. Clone the project using `git clone` or directly by running the following command

   `git clone [email protected]:KanzaTahreem/The-MealDB.git`

4. Open your editor and follow the steps mentioned below

### Install

- `npm install`

### Usage

- `npm run build`

- `npm start`

## Authors

👤 **Author**

- GitHub: [@KanzaTahreem](https://github.com/KanzaTahreem)

- Twitter: [@kanza_tahreem](https://twitter.com/kanza_tahreem)

- LinkedIn: [Kanza Tahreem](https://www.linkedin.com/in/kanza-tahreem/)

## Authors

👤 **Author**

- GitHub : [@OsvaldoBC](https://github.com/OsvaldoBC)

- Twitter : [@OsvaldoBarrio20](https://twitter.com/OsvaldoBarrio20)

- LinkedIn: [osvaldo-barrios-data-science](https://linkedin.com/inosvaldo-barrios-data-science)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/KanzaTahreem/The-MealDB/issues).

## Show your support

Give a ⭐️ if you like this project!

## 📝 License

This project is [MIT](./LICENSE) licensed.