Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/katarighe/capstone-meal-db

MealDB is a simple web app build on an external API based on the exact name, and an Involvement API which is used to record the user interactions including likes, and comments.
https://github.com/katarighe/capstone-meal-db

capstone-project css css3 html javascript microverse microverse-projects

Last synced: 23 days ago
JSON representation

MealDB is a simple web app build on an external API based on the exact name, and an Involvement API which is used to record the user interactions including likes, and comments.

Awesome Lists containing this project

README 

        
# Microverse Capstone Project (MealDB)




# 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)



# 📖 Microverse Capstone Project (MealDB)



> This Capstone Project is built on MealDB, an external API, and an Involvement API which is used to record the user interactions including likes, and comments. 



The external API service used is called MealAPI. MealDB is a crowd-sourced database of recipes from around the world. It was created in 2008 by two developers in the UK, and it has since grown to include over 29,000 recipes from over 100 countries. 



It is a free resource, and anyone can contribute recipes or edit existing ones. The database is organized by category, cuisine, ingredient, and country. Users can search for recipes by name, ingredient, or keyword. It shows that MealDB is a valuable resource for anyone who loves to cook or who is looking for new recipes to try. Therefore, it is a great resource for developers who want to create applications that allow users to find and share recipes.



This project is built as part of the 12-month Microverse Full-Stack Web Development Program, mostly on JavaScript tasks.



(back to top)



## 🛠 Built With 



### Tech Stack 

This capstone project is built and configured using the following tools:



  Languages

  



  Development Applications

  



Git / GitHub

  



Web Configuration Applications

  



### Key Features 



The three key features used in my MealDB API project include: 



- The first feature introduces the main page of the app, which displays a list of meals.

- The second feature describes the popup window that appears when a user clicks on a meal. The popup window contains more information about the meal, such as the ingredients, preparation instructions, and a list of comments.

- The third feature states that the number of likes and comments for each meal is also displayed on the main page.



(back to top)



## 🚀 Live Demo 



The Live Demo of this Capstone Project is available now on GitHub Pages and YouTube.



- [Live Demo Link on GitHub pages](https://katarighe.github.io/Capstone-Meal-DB/dist/)

- [Video Presentation of the Website on YouTube](https://www.youtube.com/watch?v=E3CNtayF4qY) 



(back to top)



## 💻 Getting Started 



The project you will build is an online website that uses an external API service. The repository provides design guidelines for creating the website, but it is important to personalize your project with something unique to add to your portfolio for job searching.



The website will be based on an external API service, which means that it will pull data from another source. This could be a database, a web service, or another API. The repository provides some of the design guidelines for creating the website, such as the layout, the colors, and the fonts. However, it is important to personalize your project by adding your own unique touches. This could include using a different color scheme, adding custom graphics, or creating a unique user interface.



### 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]:katarighe/Capstone-Meal-DB.git`



4. Open your editor and follow the steps mentioned below



### Install



- `npm install`



### Usage



- `npm run build`

- `npm start`



(back to top)



## 👥 Authors 



👤 **Mohamed Aden Ighe**



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

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

- LinkedIn: [@mighe](https://linkedin.com/in/mighe)



👤 **Lawmsangi Varte**



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

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

- LinkedIn: [@Lawmsangi Varte](https://www.linkedin.com/in/lawmsangi-varte-baa429244/)



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](https://github.com/katarighe/Capstone-Meal-DB/issues).



(back to top)



## ⭐️ Show your support 



Give a star⭐️ or a thumbs up 👍 if you like this project! You can visit my GitHub profile for more of my projects. 



(back to top)



## 🙏 Acknowledgments 



- Project supervised by [Microverse](https//www.microverse.org/) 

- Link to the FoodDB API is available [here](https://www.themealdb.com/api.php)

- [Creative Commons 4.0 License](https://creativecommons.org/licenses/by-nc/4.0/)



(back to top)



## 📝 License 



This project is MIT licensed.



(back to top)