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

https://github.com/fuadmoin/food-recipes

Food Recipes is a simple project that display sea-foods from TheMealDb Api. The user can like, comment and look the description of each foods.
https://github.com/fuadmoin/food-recipes

api css html javascript jest webpack

Last synced: 2 months ago
JSON representation

Food Recipes is a simple project that display sea-foods from TheMealDb Api. The user can like, comment and look the description of each foods.

Awesome Lists containing this project

README

          



logo

Food Recipes

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [🔭 Watch video](#watch-video)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Food Recipes

**Food Recipes** is a simple project that display sea-foods from [TheMealDb](https://www.themealdb.com/api.php) Api. The user can like, comment and look the description of each foods.

## Project view:
> Home page view

![homepage](https://user-images.githubusercontent.com/104775335/226866229-cf14f47e-5005-49de-840a-1c6d42427fb1.png)

> Comment popup view

![comment](https://user-images.githubusercontent.com/104775335/226866717-e366d6e3-dead-4a3d-9228-e9681fdf204d.png)

## 🛠 Built With

### Tech Stack

- **HTML, CSS, and JavaScript, Api, Webpack, Jest**

### Key Features

- **html styled with css and javascript**
- **uses webpack**
- **uses Api**

(back to top)

## 🚀 Live Demo

> Check out the live demo for this project [here.](https://fuadmoin.github.io/Food-Recipes/dist/)

(back to top)

## 🔭 Watch Video

> Check out the video for this project [here.](https://drive.google.com/file/d/1nkuM7ZcOTUbiwCnHzlkZ1JUflAdbpRLP/view?usp=sharing)

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:
```sh
A Computer (MAC or PC)
Code editor (VSCode,Atom etc...)
A browser (Chrome,Mozilla,Safari etc...)
Version Control System (Git and Github)
NodeJS (https://nodejs.org/en/)
```
### Setup

Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/fuadmoin/Food-Recipes.git
```
### Install

Install this project with:

```sh
npm install
```

### Usage
```sh
npm run build
npm start
```

### Run tests

To run, run the following command:
```sh
npm test
```
### Deployment

You can deploy this project using:
```sh
Github Pages
```

(back to top)

## 👥 Authors

👤 **Fuad Abdlemoin**

- GitHub: [@fuadmoin](https://github.com/fuadmoin)
- Twitter: [@Fuad01804580](https://twitter.com/Fuad01804580)
- LinkedIn: [Fuad Moin](https://www.linkedin.com/in/fuad-moin-a7b126259/)

👤 **Yidnekachew Kassahun**

- GitHub: [Yidne](https://github.com/Yidnekachew-cmd)
- Twitter: [Yidne](https://twitter.com/Yidnekassahun)
- LinkedIn: [Yidne](https://www.linkedin.com/in/yidnekachew-kassahun-2b817a24b/)

(back to top)

## 🔭 Future Features

- [ ] **Add more meal categories**
- [ ] **Adding some backend features**
- [ ] **Mobile version of the page will be added**

(back to top)

## 🤝 Contributing

Contributions, [issues](https://github.com/fuadmoin/Food-Recipes/issues), and feature requests are welcome!

(back to top)

## ⭐️ Show your support

If you like this project please consider starring it.

(back to top)

## 🙏 Acknowledgments

We would like to thank [Microverse](www.microverse.com) and [TheMealDb](https://www.themealdb.com/api.php) Api

(back to top)

## 📝 License

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

(back to top)