Zainab-Alzubair/the-meal

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 The Meal

In this project, a website for Meals is being build. The external API used for showing Meals and its details is MealsDB API. The webapp have 2 user interfaces.

• A home page showing a list of meals items that you can "like."
• A popup window with more data about the meal that you can use to comment on it.

🛠 Built With

• HTML
• CSS
• Javascript
• Webpack
• APIs
• Jest

Tech Stack

Webpack

• Webpack

Jest

• Jest

Key Features

• Develop webapp around an API
• Conduct test to ensure all edge cases are covered
• Create web page using given wireframe
• Users can filter amount of movies displayed

(back to top)

🚀 Live Demo

• Live Demo Link

🚀 Project Details

• Kanban Board

• Team

  • Zainab Alzubair - Mohamed Khaled

🚀 Pull Request

Zainab

Mohamed)

💻 Getting Started

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

Clone Git Repository

-Reach to following Github URL:

https://github.com/Zainab-Alzubair/the-meal

-Copy the URL.

-In Visual Studio Code “Terminal” change the current working directory to the location where you want the cloned directory.

-Type git clone in the terminal, paste the URL you copied earlier, and press “enter” to create your local clone.

$ git clone {repository URL}

Install Dependencies(with following Command)

• npm install

Build webpack

• run command

npm run build

Start server

npm start

Prerequisites

In order to run this project you need:

• Basic Knowledge of HTML, CSS, & JavaScript.
• Basic knowledge of ES6 syntax.
• Basic knowledge of Git, GitHub &Gitflow.
• Basic knowledge of Linters.
• Basic knowledge of Webpack.
• Basic knowledge of Jest unit-testing library.
• Basic knowledge of VS Code or any other code-editors.

Setup

Clone this repository to your desired folder:

_cd PATH_

_git clone https://github.com/Zainab-Alzubair/the-meal.git_

cd Javascript-Group-Capstone

npm install

npm run build

npm start

Install

Install this project with:

  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm test

Deployment

You can deploy this project using:

  npm start

(back to top)

👥 Authors

👤 Zainab Alzubair

• GitHub: @Zainab-Alzubair
• LinkedIn: @Zainab-Alzubair

👤 Mohamed Khaled

• GitHub: @Mohamed Khaled
• LinkedIn: @Mohamed Khaled

(back to top)

🔭 Future Features

• Implement additional home pages, one page per category of movies

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• Thanks to Microverse for giving this opportunity to learn ...
• Code Reviewers & Coding Partners.
• Hat tip to anyone whose code was used.

(back to top)

❓ FAQ

• How to generate a new key for the API?

• Open VScode and generate a key by using the following command

curl -X POST https://us-central1-involvement-api.cloudfunctions.net/capstoneApi/apps/

(back to top)

📝 License

This project is MIT licensed.

(back to top)