Capstone Meals DB

📗 Table of Contents

• 📖 About the Project
• Video Walkthrough
• • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Capstone Meals DB

Capstone Meals DB is a project that was created to inline with the Microverse curriculumn. It is an app that makes calls to an api and displays a list of different meals posted as cards on the homepage. A user can like a meal card and the record saved to an API. In addition, the user can click on a comments button to view a recipe for creating the meal. In the comments section, the user can comment on a meals recipe and the result is posted to an API. On page popup-loading, information and comments of a certain meal are retrieved and posted.

🚀 Video Walkthrough

You can find a video walkthrough of the project on the link below:

• Video Walkthrough

(back to top)

🛠 Built With

Tech Stack

Client

• HTML and CSS
• JavaScript
• Webpack and API

Key Features

We have implemented the following main features:

• [Homepage] This section shows the different meals a user can prepare in the kitchen.

• [Comments_Popup] This section shows the step by step guide to preparing a selected meal. The user can also make comments to a meals on this popup.

• [Likes] A user can like a meal various meals on the homepage.

• [Comments] A user can comment on a specific meal he/she likes by clicking on the comment button.

(back to top)

💻 Getting Started

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

Prerequisites </>

In order to set up a local copy of this repository, you need to have git installed:

Install Git

Setup

Clone this repository to your desired folder:

Commands:

  mkdir projects
  cd projects
  git clone https://github.com/microvese-projects/capstone-meals-DB.git
  npm install

Usage

To run the project:

Run

  npm start

Usage

Tests can be run through the command below:

  npm run test

(back to top)

👥 Authors

👤 Benson Njuguna

• GitHub: @bennyjoez
• Twitter: @bennyjoezz

👤 Rushema Anicet

• GitHub: @rushemaa
• LinkedIn: Rushema Anicet

(back to top)

🔭 Future Features

We plan to add the following features in future:

• [Ingredients]
• [Meal_Presentation]
• [Edit_Comment]

(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, you can show your support by giving this project's repository a star on github.

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for the outstanding collection of information they have provided that enabled us to create the project.

📝 License

This project is MIT licensed.

(back to top)