From ddc4be1d05266cea483a080850eecb319ef551eb Mon Sep 17 00:00:00 2001 From: SuyeshJadhav Date: Wed, 5 Nov 2025 22:28:03 -0500 Subject: [PATCH 1/3] Update Readme.md --- Project2/README.md | 228 +++++++++++++++++++++++++++++++++++++++------ 1 file changed, 198 insertions(+), 30 deletions(-) diff --git a/Project2/README.md b/Project2/README.md index 489a444..6fcf2fe 100644 --- a/Project2/README.md +++ b/Project2/README.md @@ -1,42 +1,210 @@ -# WolfBite +# WolfBite ๐Ÿบ -![Flutter CI](https://github.com/SuyeshJadhav/CSC510_G19/actions/workflows/flutter-ci.yml/badge.svg) +

+ Flutter Version + + CI/CD Status + + + Documentation + + + License + + + DOI + + Code Style + GitHub Issues + GitHub Stars +

-A food delivery app with a main feature that uses a barcode reader for WIC eligibility checking. This project is developed for the CSC510 software engineering course. +

+ A modern food delivery application with WIC eligibility verification +

+ +

+ Features โ€ข + Quick Start โ€ข + Documentation โ€ข + Contributing โ€ข + License +

--- -## ๐Ÿš€ Quick Start Guide +## ๐Ÿ“– About + +**WolfBite** is a cross-platform food delivery application developed for the CSC510 Software Engineering course at NC State University. The app features an innovative barcode scanning system that helps users verify WIC (Women, Infants, and Children) product eligibility in real-time. + +### Key Highlights + +- ๐Ÿ” **Smart Scanning**: Real-time barcode scanning with WIC eligibility verification +- ๐Ÿ” **Secure Authentication**: Firebase-powered user authentication +- ๐ŸŽจ **Modern UI**: Intuitive and responsive design -This guide provides a short overview of how to get the WolfBite project running locally. +--- + +## โœจ Features -1. **Clone the repository:** - ```bash - git clone [https://github.com/SuyeshJadhav/CSC510_G19.git](https://github.com/SuyeshJadhav/CSC510_G19.git) - ``` -2. **Navigate to the project directory:** - ```bash - cd CSC510_G19/project2 - ``` -3. **Install dependencies:** - ```bash - flutter pub get - ``` -4. **Run the app:** - ```bash - flutter run - ``` +- **Barcode Scanner**: Scan product barcodes to check WIC eligibility instantly +- **User Authentication**: Secure sign-up and login with Firebase +- **Shopping Cart**: Add items and manage your cart seamlessly +- **Order Management**: Track your orders in real-time +- **Responsive Design**: Optimized for mobile and web platforms --- -## ๐Ÿ“ฆ Third-Party Dependencies +## ๐Ÿš€ Quick Start + +### Prerequisites + +Before you begin, ensure you have the following installed: + +- [Flutter SDK](https://flutter.dev/docs/get-started/install) (3.9.2 or higher) +- [Dart SDK](https://dart.dev/get-dart) (included with Flutter) +- [Git](https://git-scm.com/downloads) +- A code editor (VS Code, Android Studio, or IntelliJ IDEA recommended) + +### Installation + +1. **Clone the repository** + + ```bash + git clone https://github.com/SuyeshJadhav/CSC510_G19.git + cd CSC510_G19/Project2 + ``` + +2. **Install dependencies** + + ```bash + flutter pub get + ``` + +3. **Configure Firebase** (if applicable) + + - Add your `google-services.json` (Android) and `GoogleService-Info.plist` (iOS) + - Update Firebase configuration in the project + +4. **Run the application** + + ```bash + # For web + flutter run -d chrome + + # For mobile (with device connected) + flutter run + + # For specific platform + flutter run -d + ``` + +5. **Build for production** + + ```bash + # Android APK + flutter build apk --release + + # iOS + flutter build ios --release + + # Web + flutter build web --release + ``` + +--- + +## ๐Ÿ“ฆ Dependencies + +Our project leverages these carefully selected packages: + +| Package | Version | Purpose | License | Documentation | +| ----------------- | -------- | -------------------- | ------------ | ------------------------------------------------ | +| `firebase_core` | ^4.2.0 | Firebase integration | BSD 3-Clause | [Docs](https://pub.dev/packages/firebase_core) | +| `firebase_auth` | Latest | User authentication | BSD 3-Clause | [Docs](https://pub.dev/packages/firebase_auth) | +| `cloud_firestore` | Latest | Cloud database | BSD 3-Clause | [Docs](https://pub.dev/packages/cloud_firestore) | +| `go_router` | ^16.2.5 | Navigation & routing | BSD 3-Clause | [Docs](https://pub.dev/packages/go_router) | +| `provider` | ^6.1.5+1 | State management | MIT | [Docs](https://pub.dev/packages/provider) | +| `mobile_scanner` | ^7.1.2 | Barcode scanning | BSD 3-Clause | [Docs](https://pub.dev/packages/mobile_scanner) | +| `qr_flutter` | ^4.1.0 | QR code generation | BSD 3-Clause | [Docs](https://pub.dev/packages/qr_flutter) | + +> **Note**: All dependencies are automatically installed via `flutter pub get` + +## ๐Ÿงช Testing + +Run the test suite to ensure code quality: + +```bash +# Run all tests +flutter test + +# Run tests with coverage +flutter test --coverage + +# Run specific test file +flutter test test/screens/signup_page_test.dart +``` + +--- + +## ๐Ÿ“š Documentation + +- [User Guide](https://suyeshjadhav.github.io/CSC510_G19/) - Comprehensive user documentation +- [API Documentation](docs/API.md) - API reference and endpoints +- [Contributing Guidelines](https://github.com/SuyeshJadhav/CSC510_G19/blob/main/Project2/CONTRIBUTING.md) - How to contribute to this project +- [Code of Conduct](https://github.com/SuyeshJadhav/CSC510_G19/blob/main/Project2/CODE_OF_CONDUCT.md) - Community guidelines + +--- + +## ๐Ÿค Contributing + +We welcome contributions! Please see our [Contributing Guidelines](https://github.com/SuyeshJadhav/CSC510_G19/blob/main/Project2/CONTRIBUTING.md) for details on: + +- Setting up the development environment +- Code style and standards +- Submitting pull requests +- Reporting issues + +### Development Workflow + +1. Fork the repository +2. Create a feature branch (`git checkout -b feature/amazing-feature`) +3. Make your changes and commit (`git commit -m 'feat: add amazing feature'`) +4. Push to your branch (`git push origin feature/amazing-feature`) +5. Open a Pull Request + +--- + +## ๐Ÿ‘ฅ Team + +**CSC510 - Group 19** + +| Name | Role | GitHub | +| ------------------------ | -------------- | ------------------------------------------------------ | +| Suyesh Jadhav | Lead Developer | [@SuyeshJadhav](https://github.com/SuyeshJadhav) | +| Digvijay Sanjeev Sonvane | Developer | [@digvijaysonvane](https://github.com/digvijaysonvane) | +| Vanaja Binay Agarwal | Developer | [@vanajaagarwal](https://github.com/vanajaagarwal) | + +--- + +## ๐Ÿ“„ License + +This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/SuyeshJadhav/CSC510_G19/blob/main/Project2/LICENSE.md) file for details. + +--- + +## ๐Ÿ“ž Support + +- **Issues**: [GitHub Issues](https://github.com/SuyeshJadhav/CSC510_G19/issues) +- **Discussions**: [GitHub Discussions](https://github.com/SuyeshJadhav/CSC510_G19/discussions) +- **Email**: [Contact Team](mailto:dsonvan@ncsu.edu) + +--- -Our project relies on the following third-party packages. All dependencies can be downloaded automatically using the `flutter pub get` command. +

+ Made with โค๏ธ by CSC510 Group 19 +

-| Package | Version | License | Link | Mandatory | -|---|---|---|---|---| -| `firebase_core` | `^4.2.0` | BSD 3-Clause | [pub.dev link](https://pub.dev/packages/firebase_core) | Yes | -| `go_router` | `^16.2.5` | BSD 3-Clause | [pub.dev link](https://pub.dev/packages/go_router) | Yes | -| `provider` | `^6.1.5+1` | **MIT** | [pub.dev link](https://pub.dev/packages/provider) | Yes | -| `mobile_scanner` | `^7.1.2` | BSD 3-Clause | [pub.dev link](https://pub.dev/packages/mobile_scanner) | Yes | -| `qr_flutter` | `^4.1.0` | BSD 3-Clause | [pub.dev link](https://pub.dev/packages/qr_flutter) | Yes | +

+ Built with Flutter โ€ข Powered by Firebase +

From 44d46964e79be4727dfb0edb7cd5ec2102d4c5df Mon Sep 17 00:00:00 2001 From: SuyeshJadhav Date: Wed, 5 Nov 2025 22:32:58 -0500 Subject: [PATCH 2/3] fix: updated zenodo doi --- Project2/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Project2/README.md b/Project2/README.md index 6fcf2fe..f4ad023 100644 --- a/Project2/README.md +++ b/Project2/README.md @@ -11,10 +11,9 @@ License - - DOI + + DOI - Code Style GitHub Issues GitHub Stars

From 570d3e2a007a3d32f019528b75d60f35114d77e9 Mon Sep 17 00:00:00 2001 From: SuyeshJadhav Date: Wed, 5 Nov 2025 22:45:58 -0500 Subject: [PATCH 3/3] fix: update github ids --- Project2/README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/Project2/README.md b/Project2/README.md index f4ad023..d0e6f40 100644 --- a/Project2/README.md +++ b/Project2/README.md @@ -149,7 +149,6 @@ flutter test test/screens/signup_page_test.dart ## ๐Ÿ“š Documentation - [User Guide](https://suyeshjadhav.github.io/CSC510_G19/) - Comprehensive user documentation -- [API Documentation](docs/API.md) - API reference and endpoints - [Contributing Guidelines](https://github.com/SuyeshJadhav/CSC510_G19/blob/main/Project2/CONTRIBUTING.md) - How to contribute to this project - [Code of Conduct](https://github.com/SuyeshJadhav/CSC510_G19/blob/main/Project2/CODE_OF_CONDUCT.md) - Community guidelines @@ -178,11 +177,11 @@ We welcome contributions! Please see our [Contributing Guidelines](https://githu **CSC510 - Group 19** -| Name | Role | GitHub | -| ------------------------ | -------------- | ------------------------------------------------------ | -| Suyesh Jadhav | Lead Developer | [@SuyeshJadhav](https://github.com/SuyeshJadhav) | -| Digvijay Sanjeev Sonvane | Developer | [@digvijaysonvane](https://github.com/digvijaysonvane) | -| Vanaja Binay Agarwal | Developer | [@vanajaagarwal](https://github.com/vanajaagarwal) | +| Name | Role | GitHub | +| ------------------------ | --------- | ------------------------------------------------------ | +| Suyesh Jadhav | Developer | [@SuyeshJadhav](https://github.com/SuyeshJadhav) | +| Digvijay Sanjeev Sonvane | Developer | [@digvijaysonvane](https://github.com/DVJAY11) | +| Vanaja Binay Agarwal | Developer | [@vanajaagarwal](https://github.com/PositivelyBookish) | ---