From 604c98df4c9ef7349ec89932650ad7b59116b33c Mon Sep 17 00:00:00 2001 From: sajalAppdevs Date: Mon, 28 Apr 2025 19:12:11 +0600 Subject: [PATCH] update README.md --- README.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 79 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a07deac..0aa1255 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,92 @@ # Meal Tracker App -Meal Tracker application is build in flutter for android and iOS devices.In this project we used firebase database for email authentication and to store - retrieve meal data. User can edit and delete meals also. For email and password user can also edit their email and password using firebase authentication. User can change theme mode according to their preference. This meal planner app have beautiful and smooth user friendly UI design. +A beautiful and feature-rich meal tracking application built with Flutter for Android and iOS devices. The app helps users track their daily meals with an intuitive interface, Firebase authentication, and cloud storage capabilities. -**Features**: +## Features -- Improved mobile UI/UX. +### Authentication & User Management +- Email and password authentication using Firebase +- User profile management +- Secure password update functionality +- Email address modification capability -- Fully responsive UI. +### Meal Management +- Add, edit, and delete meals +- Categorize meals (Breakfast, Lunch, Dinner, Snacks, Dessert) +- Track meals with timestamps +- Weekly and monthly meal tracking using Table Calendar -- On-boarding screen with animation. +### UI/UX +- Engaging onboarding screen with animations +- Responsive and adaptive UI design +- Theme customization options: + - Light mode + - Dark mode + - System default theme +- Beautiful and smooth transitions +- Google Fonts integration +- Toast notifications for user feedback -- Sign-up and sign in screen. +### Data Management +- Cloud Firestore database integration +- Real-time data synchronization +- Secure data storage and retrieval -- Firebase email and password authentication. +## Tech Stack -- Light, Dark and system default theme mode. +- **Frontend Framework**: Flutter +- **Backend Service**: Firebase + - Authentication + - Cloud Firestore +- **State Management**: Provider +- **UI Components**: + - Table Calendar + - Animated Text Kit + - Google Fonts + - Lottie Animations -- Used table calender for cleanly track weekly and monthly meals. +## Getting Started -- Add, update and delete meals. +### Prerequisites -- Update email and password using firebase authentication. +- Flutter SDK +- Android Studio / VS Code +- Firebase account +- Git -![Preview](meal_app.png) \ No newline at end of file +### Installation + +1. Clone the repository +```bash +git clone [repository-url] +cd MealPlannerApp +``` + +2. Install dependencies +```bash +flutter pub get +``` + +3. Configure Firebase +- Create a new Firebase project +- Add Android/iOS apps in Firebase console +- Download and add the configuration files + - `google-services.json` for Android + - `GoogleService-Info.plist` for iOS + +4. Run the app +```bash +flutter run +``` + +## Screenshots + +![Preview](meal_app.png) + +## 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. \ No newline at end of file