Meal Analyzer

Meal Analyzer is a cross-platform app for analyzing meals, likely oriented around nutrition insights, portion tracking, or diet logging. Developed using Flutter, it targets Android, iOS, Linux, macOS, Windows, and web platforms.

Features

• Multi-platform support (Android, iOS, Desktop, Web)
• Modular architecture with configuration, models, services, screens, and reusable widgets
• Easily customizable and extensible for meal-related analysis tasks

Table of Contents

• Getting Started
• Project Structure
• Usage
• Development
• Testing
• Contributing
• License

Getting Started

Prerequisites

• Flutter SDK (preferably latest stable)
• A compatible IDE (VS Code, Android Studio, IntelliJ)
• Platform-specific dependencies as needed (see Flutter setup guide)

Attention ❗

Before you run this app, please make sure to create a vars.env file in the root directory of this project. This file should contain your Google API key:

API_KEY=YOUR_API_KEY

Caution: Do NOT commit the .env file to your version control system (e.g., Git). It contains sensitive information that should be kept private.

Installation

1. Clone the repository

   git clone https://github.com/sgkouzias/meal_analyzer.git
   cd meal_analyzer

2. Install dependencies

   flutter pub get

3. Get platform-specific dependencies

   For iOS:

   cd ios
   pod install
   cd ..

   For web: No extra steps required after flutter pub get.

4. Run the app

   flutter run

   You may be prompted to pick a device/simulator.

Project Structure

meal_analyzer/
├── lib/
│   ├── config/      # Application configuration files
│   ├── main.dart    # Main entry point
│   ├── models/      # Data models (e.g. meal, nutrition)
│   ├── screens/     # Individual app screens/pages
│   ├── services/    # Service classes (data fetch, analysis logic)
│   └── widgets/     # Reusable UI components
├── android/         # Android-specific code
├── ios/             # iOS-specific code
├── linux/           # Linux-specific code
├── macos/           # macOS-specific code
├── windows/         # Windows-specific code
├── web/             # Web-specific code
├── test/            # Test files
├── pubspec.yaml     # Flutter dependencies and metadata
└── README.md        # This file

Usage

• Launch the app on your favorite device!
• Input your meal or relevant data as instructed in-app.
• Review the analysis screen for feedback, details, or recommendations.

Development

• Place new pages in lib/screens/.
• Add data structures in lib/models/.
• Add service classes to lib/services/.
• Create reusable UI in lib/widgets/.
• Update configuration in lib/config/.

Code Quality

• Formatting: flutter format .
• Linting: run flutter analyze (settings defined in analysis_options.yaml).

Testing

• Unit and widget tests are placed in the test/ directory.
• To run all tests:

  flutter test

Contributing

Contributions are welcome! Please open issues or submit pull requests for improvements, bug fixes, or new features.

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

License

This project is licensed under the terms described in the repository. See LICENSE if available.