From 873bf9d1a55a1fe27a997eda7b8e8b0b48515591 Mon Sep 17 00:00:00 2001 From: sajalAppdevs Date: Wed, 23 Apr 2025 21:37:40 +0600 Subject: [PATCH] updated README.md --- README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 61 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e37bcda..818f9a1 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,67 @@ -# fluttercocktail +# Cocktail App 🍸 -A new Flutter project. +A Flutter-based mobile application for cocktail enthusiasts to discover, explore, and learn about various cocktails and beverages. This app integrates with TheCocktailDB API 1 to provide a comprehensive cocktail database and recipe collection. -## Getting Started +## Features 🌟 -This project is a starting point for a Flutter application. +- Browse an extensive collection of cocktail recipes +- Search cocktails by name, ingredient, or category +- View detailed recipe instructions and ingredients +- Discover random cocktails for inspiration +- Beautiful and intuitive user interface -A few resources to get you started if this is your first Flutter project: +## Getting Started 🚀 -- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook) +### Prerequisites -For help getting started with Flutter, view our -[online documentation](https://flutter.dev/docs), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +- Flutter SDK (latest stable version) +- Android Studio / VS Code with Flutter extensions +- Android SDK for Android development +- Xcode (for iOS development, macOS only) + +### Installation + +1. Clone the repository: + ```bash + git clone https://github.com/yourusername/Cocktail-App.git + cd Cocktail-App + ``` + +2. Install dependencies: + ```bash + flutter pub get + ``` + +3. Run the app: + ```bash + flutter run + ``` + +## API Integration 🔗 + +This app uses TheCocktailDB API for fetching cocktail data 1. The API provides: +- Comprehensive cocktail database +- Detailed recipe information +- High-quality cocktail images +- Search and filter capabilities + +## Development Setup 💻 + +1. Set up your preferred IDE (Android Studio or VS Code) +2. Install Flutter and Dart plugins +3. Configure Flutter SDK path +4. Set up Android/iOS emulator or connect a physical device + +## Contributing 🤝 + +Contributions are welcome! Please feel free to submit a Pull Request. + +## License 📄 + +This project is licensed under the MIT License - see the LICENSE file for details. + +## Acknowledgments 🙏 + +- [TheCocktailDB](https://www.thecocktaildb.com/) for providing the cocktail database API 2 +- Flutter team for the amazing framework +- All contributors who help improve this project