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

https://github.com/iamsjunaid/mealsdb

MealsDB is an application that uses an external API mealsDB to fetch and store the data from. The project contains meals that a user can like, comment and reserve.
https://github.com/iamsjunaid/mealsdb

css html javascript jest webpack

Last synced: 9 months ago
JSON representation

MealsDB is an application that uses an external API mealsDB to fetch and store the data from. The project contains meals that a user can like, comment and reserve.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 MealsDB ](#-to-do-list-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)

# 📖 MealsDB

**MealsDB** is an application that uses an external API [mealsDB](https://www.themealdb.com/api.php) to fetch and store the data from. The project contains meals that a user can like, comment and reserve.

## 🛠 Built With
> a combination of HTML CSS and JavaScript

### Tech Stack

> HTML
> CSS
> Webpack
> linters: lighthouse, webhint, stylelint, eslint
> JavaScript
> with the help of VS Ccode

### Key Features

- **Impressive user interface**
- **User friendly**
- **powerful interactive features**

(back to top)

## 🎥 Walkthrough Video

- [Video Walkthrough](https://drive.google.com/file/d/1Ov4gX_gGTdiXow_t_9anMLQ0lHgfTBQ9/view?usp=sharing)

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://iamsjunaid.github.io/MealsDB/)

(back to top)

## 💻 Getting Started

### Prerequisites

In order to run this project you need:

Example command:

```sh
nodeJS --v18.0
```

### Setup

Clone this repository to your desired folder:

Example commands:

```sh
cd my-folder
git clone https://github.com/iamsjunaid/mealsdb.git
```

### Install

Install this project with:

Example command:

```sh
cd my-project
npm install
```

### Usage

To run the project, execute the following command:

Example command:

```sh
npm start
```

### Run tests

To run tests, run the following command:

Example command:

```sh
npm test
```

### Deployment

You can deploy this project using:

Example:

```sh
gh-pages
```

(back to top)

## 👥 Authors

👤 **Junaid**

- GitHub: [@iamsjunaid](https://github.com/iamsjunaid)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/junaid-syed-058b2779)

👤 **Emmanuel**

- GitHub: [@uno36](https://github.com/uno36)
- Twitter: [@tofauemmanuel](https://twitter.com/tofauemmanuel)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/emmanuel-tofa-673b2516a/)

👤 **Peter**

- GitHub: [@Peter-Dumbari](https://github.com/Peter-Dumbari)
- Twitter: [@Lazkkidy](https://twitter.com/Lazkkidy)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/peter-kinz-7aa419235/)

(back to top)

..

## 🔭 Future Features

- [ ] **linkers**
- [ ] **visionary**
- [ ] **likable display**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/iamsjunaid/js-capstone-2/issues).

(back to top)

## ⭐️ Show your support

If you like this project dont hesitate to contact us

(back to top)

## 🙏 Acknowledgments

we would like to thank Microverse for their continued support

(back to top)

## 📝 License

This project is [MIT](https://github.com/iamsjunaid/js-capstone-2/blob/dev/LICENSE) licensed.