HomeStock - Pantry Management App

HomeStock is a Flutter-based mobile application that helps you manage your home pantry efficiently. Track food items, monitor expiration dates, and streamline your grocery shopping process - all in one place.

✨ Features

• 🍎 Inventory Tracking: Maintain a detailed database of all food items in your pantry
• ⏱️ Expiration Monitoring: Get alerts on items nearing expiration to reduce food waste
• 🛒 Shopping Cart Integration: Easily add depleted items to your shopping list
• 🔍 Category Filtering: Browse your pantry by food categories (Vegetables, Grains, Dairy, etc.)
• 🗑️ Bin Management: Archive expired or consumed items for future reference
• 📊 Quantity Control: Track and update quantities as you use items

📸 Screenshots

🚀 Installation

Prerequisites

• Flutter (version 3.0.0 or higher)
• Dart (version 2.17.0 or higher)
• Android Studio / Xcode for emulators

# Clone the repository
git clone https://github.com/your-username/homestock.git

# Navigate to the project directory
cd homestock

# Get Flutter dependencies
flutter pub get

# Run the app
flutter run

# Build APK
flutter build apk

# Build iOS
flutter build ios

🔧 Project Structure

lib/
├── main.dart
├── database
├── models
│   ├── repositories/
│   └── services/
├── utils/
│   └── constants/
│   └── device/
│   └── helpers/
│   └── themes/
├── views
└──  widgets
     └── custom_shapes/
     └── custom_widgets/

🛠️ Tech Stack

• Framework: Flutter
• Language: Dart
• State Management: Getx
• Database: SQLite
• CI/CD: GitHub Actions

📋 Usage Guide

1. Adding Items: Tap the "+" button to add new items to your inventory
2. Managing Quantities: Use the +/- buttons to adjust quantities
3. Shopping: Items with 0 quantity are added to shopping suggestions
4. Expiration Tracking: Items are color-coded based on expiration status
5. Bin Management: Access the Bin to see expired or finished items

🧪 Running Tests

# Run unit tests
flutter test

# Run integration tests
flutter test integration_test

# Check code coverage
flutter test --coverage

📱 Supported Platforms

• Android
• iOS
• Web (future support)

🔄 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Please ensure your code follows the project's style guidelines and passes all tests.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.