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

https://github.com/yordinia/javascript-capstone

A web app that uses's Meals API to grap and display meals, and Interactive API to manage likes and comments.
https://github.com/yordinia/javascript-capstone

css html javascript jest-tests webpack

Last synced: about 2 months ago
JSON representation

A web app that uses's Meals API to grap and display meals, and Interactive API to manage likes and comments.

Awesome Lists containing this project

README

          

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

# 📖 JavaScript Capstone Project - Meals App

# 📗 Table of Contents

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

# 📖 JavaScript Capstone Project meals app

**JavaScript Capstone Project meals app** is a progressive web app that displays meals fetched from an API, and also displays comments about the meal submitted by different viewers. It also allows you like a certain element, thanks to the additional Capstone-API provided by microverse.

## 🛠 Built With

- **Node NPM manager**
- **Front-end dev languages**
- **Served with webpack**
- **Deployed with gh-pages**
- **Tested with Jest**

### Tech Stack

Client


  • HTML

  • Javascript & DOM

  • ES6 modules

  • Webpack

  • API

  • Jest

### Key Features

- **use gitflow**
- **connect to the Meals API**
- **sends, receives and deisplay data from these two APIs.**
- **[Meals API](https://www.themealdb.com/api/json/v1/1/filter.php?c=Chicken)**
- **[Interactive API](https://us-central1-involvement-api.cloudfunctions.net/capstoneApi/apps/9vUKLfgfPbeVlsgu5dzp)**

(back to top)

## 💻 Getting Started

## 🚀 Live Demo

- Coming Soon

## 🚀 Zoom Video (explanation)

[Author's Explanation](https://drive.google.com/file/d/1UiVaUWXq7xTGcRfd5qR4ujbL2HQR6b1j/view?usp=sharing)

(back to top)

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

### Prerequisites

Run the following commands, in order to run this project: - `npm install` - For tests `npm i jest-environment-jsdom --save-dev && npm test`

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone git@github.com:yordinia/JavaScript-Capstone.git
```

### Install

Install this project with:

```sh
cd JavaScript-Capstone
npm install
```

### Usage

To use this project - Run `npm start` or `npm run build` - Open `index.html` from /dist with your prefered browser

(back to top)

## 👥 Author

👤 **Misal Azeem**

- GitHub: [@misalazeem](https://github.com/misalazeem)
- Twitter: [@misal_azeem](https://twitter.com/misal_azeem)
- LinkedIn:[@misal-94755a82](https://www.linkedin.com/in/misal-94755a82/)

👤 **Yordanos Temesgen**

- GitHub: [@yordinia](https://github.com/yordinia)
- Twitter: [@yordinaM](https://twitter.com/yordinaM)
- LinkedIn: [@yordanos-temesgen-941727233](https://www.linkedin.com/in/yordanos-temesgen-941727233/)

(back to top)

## 🔭 Future Features

- [ ] **Set up the resevations section**
- [ ] **Better UI, speed and interactivity**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/yordinia/JavaScript-Capstone/issues).

(back to top)

## ⭐️ Show your support

If you like this project please give a star ⭐️ to this project

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse team, coding partners for the amazing collobrating project

(back to top)

## 📝 License

This project is [MIT](https://github.com/Yordinia/yordinia/blob/main/LICENCE.md) licensed.

(back to top)