📗 Table of Contents

📗 Table of Contents

• 📖 Meal App
• 🛠 Built With
• 🚀 Live Demo
• 💻 Getting Started
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgments
• 📝 License

📖 Meal App

Meal App is web application that helps you decide your next meal. Select a meal to see how its prepared, or post a comment on how delicious it is. Don't forget to like 🧡 your favorites

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript
• Webpack
• Jest

Key Features

• Fetches and displays meal information under different categories from the mealdb API
• Fetches and displays likes and comments for each meal using the involement API
• Displays loading screens to the user during fetch
• Displays additional meal information in a modal popup
• Allows users to like meals
• Allows users to comment on meals
• Allows users to search for meals
• Responsive design which adapts to most screen sizes

(back to top)

🚀 Live Demo

• Live Demo Link

(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:

 git
 npm
 node
 Your favorite text editor

Setup

Clone this repository to your desired folder:

  git clone https://github.com/Shisui6/meal-app.git

Install

Install this project with:

  cd meal-app
  npm install

Usage

To run the project, execute the following command:

  npm run build - Builds development files into production code
  npm start - Starts the development server

Run tests

To run tests, run the following command:

  npm test - Launches the test runner in the interactive   watch mode

Deployment

You can deploy this project using:

  npm run deploy - Deploys using gh-pages

API Instructions

Instructions to setup Involvement API key are as follows:

- Create a new app on your command line using ` curl -X POST https://us-central1-involvement-api.cloudfunctions.net/capstoneApi/apps/ `
- Add the returned API key to a `.env` file in your root directory using `API_KEY=returnedApiKey`
- Note: make sure to replace `returnedApiKey` with your API key

(back to top)

👥 Authors

👤 Shisui

• GitHub: @Shisui6
• LinkedIn: LinkedIn

👤 Ahmed

• GitHub: @boo-shehab
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Create user profiles
• Save favorite meals for users on their dashboard

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please leave a star🤩

(back to top)

🙏 Acknowledgments

• Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)