abdullah-25/pair-programming

Welcome to the QuickMeals repository! This repository houses the source code for the QuickMeals project. The project aims to provide a comprehensive solution for finding recipes by giving a single ingredient. The app uses an API key to generate content.

Table of Contents

• Introduction
• Features
• Demo
• Installation
• Usage
• Contributing
• License

Introduction

QuickMeals is a React front-end app that uses a public API key to fecth information regarding meals. It is built using React and SASS. The project aims to help users find delicious meals by only providing it an ingredient.

Features

• Seacrh bar: allows user to search a meal by typig up an ingredient name.
• Navigation and Routing: clicking on meal card directs a user to a different route and update the UI.
• Update of UI using React Props: Multiple props acts together to give user seamless experience.

Demo

Check out the live demo of ProjectName at https://64a9afc536a1f126b0ddd97b--joyful-sundae-eea8ff.netlify.app/ to see the project in action.

Installation

To install and run ProjectName locally, follow these steps:

1. Clone the repository: git clone https://github.com/abdullah-25/pair-programming.git

2. Navigate to the project directory: cd pair-programming

3. Install the dependencies: npm install

4. Build the project: npm run build

5. Open the index.html file in your preferred web browser.

That's it! You can now explore ProjectName locally on your machine.

Usage

Once you have ProjectName up and running, you can [describe how to use the project]. Feel free to provide any additional instructions, guidelines, or configuration details specific to the project.

Contributing

Contributions to ProjectName are welcome! If you find a bug, have suggestions for improvements, or would like to add new features, please follow these steps:

1. Fork the repository.

2. Create a new branch for your contribution: git checkout -b my-contribution

3. Make your changes, additions, or fixes.

4. Commit and push your changes to your forked repository: git commit -m "Add my contribution" git push origin my-contribution

5. Open a pull request to the original repository, providing a clear description of your contribution.

6. Engage in discussions and address any feedback or questions related to your contribution.

7. Once approved, your contribution will be merged into the main branch of the original repository.

License

This repository is licensed under the MIT License. Feel free to use, modify, and distribute the code in accordance with the terms of the license.

Thank you for your interest in contributing to QuickMeals!