https://github.com/akash-nath29/recipefinder-flask
https://github.com/akash-nath29/recipefinder-flask
Last synced: 30 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/akash-nath29/recipefinder-flask
- Owner: Akash-nath29
- License: mit
- Created: 2023-09-07T05:10:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-07T11:12:16.000Z (over 1 year ago)
- Last Synced: 2025-02-12T11:53:37.528Z (3 months ago)
- Language: CSS
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🍽️ Recipe Finder - Flask 🍲
---
## Table of Contents
- [About the Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)
---
## About the Project
Recipe Finder is a web application built with Flask that allows users to search for recipes based on ingredients or keywords. It provides a user-friendly interface for discovering new culinary delights.
### Built With
- [Python](https://www.python.org/)
- [Flask](https://flask.palletsprojects.com/)
- [Edamam Recipe Search API](https://developer.edamam.com/)
---
## Getting Started
To get started with Recipe Finder, follow these steps:
### Prerequisites
- Python (version 3.6 or higher)
- Flask (install via `pip install Flask`)
### Installation 🚀
1. Clone the repository
```sh
git clone https://github.com/Akash-nath29/recipeFinder-Flask.git
```
2. Create a virtual environment (optional but recommended)
```sh
python -m venv venv
source venv/bin/activate
```
- for windows
```sh
venv\Scripts\activate
```
3. Install dependencies
```sh
pip install -r requirements.txt
```
4. Run the application
```sh
python app.py
```
---
## Usage ✨
- Enter ingredients or keywords in the search bar. 🍳🥦🍝
- Click the "Search" button. 🔍
- Browse through the search results for delicious recipes. 🍴
---
## Contributing 🤝
Contributions are welcome! If you'd like to contribute to Recipe Finder, please follow these guidelines:
1. Fork the project. 🍴
2. Create your feature branch (`git checkout -b feature/YourFeature`). 🌟
3. Commit your changes (`git commit -m 'Add some feature'`). 💬
4. Push to the branch (`git push origin feature/YourFeature`). 🚀
5. Open a pull request. 🔗
---
## License 📄
Distributed under the MIT License. See [LICENSE](https://github.com/Akash-nath29/recipeFinder-Flask/blob/main/LICENSE) for more information.
---
## Contact 📧
- Akash Nath - [email protected]
Project Link: [https://github.com/Akash-nath29/recipeFinder-Flask](https://github.com/Akash-nath29/recipeFinder-Flask)
---
## Acknowledgements 🙏
- [Edamam Recipe Search API](https://developer.edamam.com/)