📖 JavaScript Capstone Project - Meals App

📗 Table of Contents

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

📖 JavaScript Capstone Project - Meals Web App

JavaScript Capstone Project - Meals Web App is an API-based web app that retrieves and displays a list of meals from a MEALSDB API to the UI and an Involvement API which is responsible for recording various user interactions (likes and comments)

🛠 Built With

• HTML
• CSS
• JAVASCRIPT
• WEBPACK

Tech Stack

Client

• HTML & CSS
• JavaScript & ES6 Modules
• Webpack
• API
• Jest

Key Features

• Comments: The API endpoint allows users to leave comments on specific meals and also tracks the number of comments
• Likes: The API allows enables users to express their preferences by tracking the number of likes passed on specific meals
• Meals info: The API provides endpoints that retrieve details about meals, including image, category, ingredients, and instructions.
• API's USED
  • Meals API - for retrieving and displaying meals on the UI
  • Interactive API - for user interactions such as likes and comments.

🚀 Live Demo

• Coming Soon

🚀 Zoom Video (explanation)

Author's Explanation

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Web browser.
• Code editor.
• Git scm.

Run the following commands, in order to run this project: - npm install

For tests npm i jest-environment-jsdom --save-dev and npm run test

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/kessie2862/JavascriptCapstone.git

Install

Install this project with:

  cd JavaScriptCapstone
  npm install

Usage

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

👥 Author

👤 Prosper Kessie

• GitHub: kessie2862
• Twitter: Peekay_Codes
• LinkedIn: Prosper Kessie

👤 Evans Karanja

• GitHub: prg-04
• Twitter: Evans1425Sean
• LinkedIn: Evans Karanja

🔭 Future Features

• Implement recipe and contact pages
• Add media query to make the page responsive
• Enable sorting and filtering

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project please give a star ⭐️ to this project. You can follow to see future projects.

🙏 Acknowledgments

I'd like to thank Microverse and coding partner for his awesome contribution.

📝 License

This project is MIT licensed.