README.md

📗 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

📖 Awesome Recipes

This is a simple recipe app that allows you to search for a delightful recipe by name, and choose one based in their poularity and ratings.

🛠 Built With

Tech Stack

This app was built using the following technologies:

Client

• React
• Redux
• React-Bootstrap
• Bootstrap 5

APIs

• TastyAPI

Key Features

• Search for a recipe by name.
• Choose a recipe based on their popularity and ratings.
• Sort recipes by alphabetical order, popularity and ratings.
• See the recipe details (ingredients, instructions, etc).
• See information about the app.

(back to top)

🚀 Live Demo

• Awesome Recipes Demo link
• Video-tutorial 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:

Installed in your local machine:

• Node.js
• Git

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Camilovelag/awesome-recipes.git

Install

Install this project with:

  cd awesome-recipes
  npm install

Usage

To run the project, execute the following command:

  npm run start

Run tests

To run tests, run the following command:

  npm run test

(back to top)

👥 Authors

👤 Camilo Vela

• GitHub: @camilovelag
• Twitter: @camilovelag
• LinkedIn: camilovelag

(back to top)

🔭 Future Features

• Improve recipe details layout for desktop version.
• Improve testing coverage.

(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 leave a star.

(back to top)

🙏 Acknowledgments

I would like to say thanks to Microverse for letting us be part of this amazing program. Thanks to Nelson Sakwa for his Design visit site. And thanks to all the people who helped me to make this project possible.

(back to top)

❓ FAQ

• There are more info available to display?

  • Yes, there are. This app have a bunch of interesting info to improve the recipe details section.

• Can I add recipes?

  • This API doesn't allow add new recipes.

• Could I use a different API?

  • Yes, of course. Fetch requests are built in a separate file, so you could change the API easily.

(back to top)

📝 License

This project is MIT licensed.

(back to top)