README.md

Microverse README Template

📗 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

📖 [recipe-app]

[recipe-app] is a meal finder app that pulls from TheMealDB API to allow users to search for, view recipes, and comment on recipes.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript
• Webpack
• Tailwind CSS

Key Features

• [Fetch_API]
• [Modals]
• [Pagination]

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

• Create React App

  npm install webpack

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:topeogunleye/recipe-app.git

Install

Install this project with:

• Install Node Modules

  npm install

Usage

To run the project, execute the following command:

• Start the development server

  npm start

Run tests

To run tests, run the following command:

• Test the items Counter and Comments Counter function

  npm test
  

Deployment

You can deploy this project using:

npm run deploy

(back to top)

👥 Authors

👤 Temitope Ogunleye

• GitHub: @topeogunleye
• Twitter: @tope_leye
• LinkedIn: ogunleye

👤 Gbenga Emmanuel

• GitHub: @gbengacode

(back to top)

🔭 Future Features

• [animations]
• [deployment]

(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, kindly star it

(back to top)

🙏 Acknowledgments

I would like to thank the creators of yummly

(back to top)

❓ FAQ

• [What inspired you to build this website]

  • [I learnt how to build a recipe website from Brad traversy's 20 Web Projects With Vanilla JavaScript Course ]

• [What is your favorite food]

  • [Beans and Potatoes]

(back to top)

📝 License

This project is MIT licensed.