devmadaan/forkify

Forkify Recipe App

A web application for finding and saving your favorite recipes.

Table of Contents

• About
• Features
• Installation
• Usage
• Technologies Used
• Contributing
• License
• Acknowledgements
• Contact

About

Forkify Recipe App is a powerful and user-friendly web application that allows users to search for recipes from various sources, save their favorite recipes, and create personalized shopping lists. It simplifies the process of finding and organizing recipes, making it convenient for users to plan their meals and manage their ingredients.

Features

• Search and browse an extensive collection of recipes.
• View detailed recipe information, including ingredients, instructions, and serving sizes.
• Save favorite recipes for quick access.
• Create and manage custom shopping lists based on selected recipes.
• Interactive and intuitive user interface.
• Mobile-friendly design for a seamless experience on different devices.

Installation

1. Clone the repository:

   git clone https://github.com/devmadaan/forkify.git

2. Navigate to the project directory:

     cd forkify

3. Install the dependencies:

      npm install

4. Start the application:

      npm start

5. Open your web browser and visit http://localhost:1234 to access the application.

Usage

1. On the homepage, enter a keyword or ingredient in the search bar and click the search button.

2. Browse through the search results to find a recipe that interests you.

3. Click on a recipe to view its details, including ingredients and instructions.

4. To save a recipe, click the "Save Recipe" button. You can access saved recipes from the "Favorites" section.

5. To create a shopping list based on a recipe, click the "Add to Shopping List" button.

6. Manage your shopping list by adding or removing items as needed.

7. Enjoy exploring and organizing your favorite recipes!

Technologies Used

• HTML5
• SASS
• JavaScript
• Parcel | Module bundler
• Babel

Contributing

Contributions are welcome! If you would like to contribute to Forkify Recipe App, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your modifications and commit your changes.
4. Push your branch to your forked repository.
5. Submit a pull request with a detailed description of your changes.
6. Please ensure that your code adheres to the project's coding conventions and includes necessary tests.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgements

• The Recipe API - recipe-api.com
• The Spoonacular API - spoonacular.com
• Font Awesome - Icons and fonts

Contact

If you have any questions, suggestions, or feedback, please feel free to contact me at [email protected].

Feel free to customize and update the content based on your specific project details. Don't forget to include relevant images, icons, and the necessary license file (e.g. LICENSE)