<html> <body> <h1>Recipe App</h1> <h2>Table of Contents</h2> <ul> <li><a href="#introduction">Introduction</a></li> <li><a href="#features">Features</a></li> <li><a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#technologies-used">Technologies Used</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> </ul> <h2>Introduction</h2> <p>The Recipe App is a mobile application designed to help users discover, save, and cook delicious recipes. Whether you're a seasoned chef or a kitchen novice, this app provides a wealth of culinary inspiration and convenience.</p> <h2>Features</h2> <ul> <li><strong>Recipe Search:</strong> Easily search for recipes by ingredients, cuisine, or dietary preferences.</li> <li><strong>Recipe Details:</strong> View detailed recipe instructions, ingredients, and nutritional information.</li> <li><strong>Favorites:</strong> Save your favorite recipes for quick access.</li> <li><strong>Guest Mode:</strong> Explore recipes without the need to create an account.</li> <li><strong>Profile:</strong> Create a profile to save your favorite recipes and submit your own creations.</li> <li><strong>Real-time Updates:</strong> Stay up-to-date with the latest recipes and user-submitted content.</li> </ul> <h2>Getting Started</h2> <h3>Prerequisites</h3> <p>Before you begin, ensure you have met the following requirements:</p> <ul> <li><strong>Android Studio:</strong> Make sure you have Android Studio installed.</li> <li><strong>Firebase Account:</strong> Create a Firebase account and set up a project for authentication and real-time database features.</li> </ul> <h3>Installation</h3> <ol> <li>Clone the repository:</li> </ol> <pre><code>git clone https://github.com/ProHussain/RecipesApp.git</code></pre> <ol start="2"> <li>Open the project in Android Studio.</li> <li>Connect your app to Firebase by following the Firebase setup instructions in the project.</li> <li>Build and run the app on an Android emulator or physical device.</li> </ol> <h2>Usage</h2> <ul> <li><strong>Search for Recipes:</strong> Use the search bar to find recipes based on your preferences.</li> <li><strong>View Recipe Details:</strong> Tap on a recipe card to view detailed instructions and ingredients.</li> <li><strong>Save Favorites:</strong> Log in to save your favorite recipes.</li> <li><strong>Submit Your Own Recipes:</strong> Create a profile to submit your own recipes and share them with the community.</li> </ul> <h2>Technologies Used</h2> <ul> <li><strong>Android:</strong> The app is developed for the Android platform using Java.</li> <li><strong>Firebase:</strong> Firebase is used for authentication, real-time database, and storage.</li> <li><strong>Room Database:</strong> Room is used for local data storage and management.</li> <li><strong>RecyclerView:</strong> RecyclerView is used for displaying lists of recipes.</li> <li><strong>Glide:</strong> Glide is used for efficient image loading and caching.</li> <li><strong>Material Design:</strong> The app follows Google's Material Design guidelines for a modern and user-friendly interface.</li> </ul> <h2>Contributing</h2> <p>Contributions are welcome! If you'd like to contribute to the project, please follow these steps:</p> <ol> <li>Fork the project.</li> <li>Create a new branch for your feature or bug fix: <code>git checkout -b feature/your-feature-name</code>.</li> <li>Make your changes and commit them: <code>git commit -m 'Add some feature'</code>.</li> <li>Push to the branch: <code>git push origin feature/your-feature-name</code>.</li> <li>Submit a pull request.</li> </ol> <h2>License</h2> <p>This project is licensed under the <a href="LICENSE">MIT License</a>.</p> </body> </html>

RecipesApp

Install / Use

README