Recipe Finder

Table of Contents

• Overview
• General Instructions
• Requirements & Specifications
• Getting Started
• Acknowledgements
• About Chingu
• Developers
• Contributing

Overview

Recipe Finder is a web application designed to help users find recipes based on ingredients they have at hand. Whether you're a seasoned chef or a beginner in the kitchen, our app makes it easy to discover new and exciting dishes to prepare.

Try out the live version here.

General Instructions

This project has been developed by a collaborative Chingu Voyage team, aiming to provide a valuable tool for any culinary enthusiast. We encourage creativity and unique contributions to the project while maintaining the essence of collaborative development.

Requirements & Specifications

Structure:

• Frontend application with no backend required.
• Freedom of choice in languages, tools, or libraries.

Styling:

• Clean and distinctive design with a footer linking to the GitHub repository.

Functionality:

• User-friendly landing page with how-to-use instructions.
• Search functionality for finding recipes by ingredients.
• Interactive main and detailed recipe components.

Getting Started

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

1. Clone the repository:

   git clone https://github.com/chingu-voyages/v46-tier1-team-05.git

No dependencies are needed to run the app as it is purely front-end with HTML, CSS, Bootstrap, and vanilla JavaScript. Simply open the index.html file in your browser to get started. Bootstrap is linked through a CDN.

Acknowledgements

• Chingu - For providing the platform to collaborate and learn.
• Bootstrap - For the responsive design framework.

About Chingu

Chingu is an open global platform connecting motivated learners to build fast and learn together in remote Voyage teams.

Developers

This project is brought to you by:

• @Warlita
• @Chuelgi
• @NereidaRondon

Feel free to fork the project and submit your contributions.

Contributing

If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.

1. Fork the Project: Click the 'Fork' button on the top right of the project's GitHub page.
2. Clone your fork: Click on the 'Code' button on the GitHub repository page and copy the URL under 'Clone with HTTPS'. Then, run the following command in your local terminal:

   git clone [URL you copied from the GitHub page]

   Replace [URL you copied from the GitHub page] with the actual URL.
3. Navigate to the repository on your computer: Use the terminal to navigate to the directory where you have cloned the repo.

   cd [name-of-the-repo]

   Replace [name-of-the-repo] with the actual name of the repository.
4. Create your Feature Branch:

   git checkout -b feature/AmazingFeature

5. Make your changes: Edit, add and commit your changes.

   git add .
   git commit -m "Add your detailed description of your AmazingFeature or changes"

6. Push to the Branch:

   git push origin feature/AmazingFeature

7. Open a Pull Request: Navigate back to your forked repository and press the 'New pull request' button.

For further assistance or feedback, reach out to the developers through their GitHub profiles linked above.