Git Product home page Git Product logo

ingredients_scanner's Introduction

Ingredients Scanner

Overview

Ingredients Scanner is a cross-platform mobile application designed to scan and interpret the ingredient lists on food labels. It enhances readability and assists users in identifying undesirable ingredients. An app built with Flutter, implementing Clean Architecture and TDD principles.

Features

  • Text Recognition: Utilizes Google ML Kit for text recognition.
  • User Authentication: Powered by Firebase Authentication.
  • User Preferences: Stores user settings using SharedPreferences.
  • Clean Architecture: Adheres to clean architecture principles.
  • TDD Approach: Developed using Test-Driven Development (TDD).

Getting Started

Prerequisites

  • Flutter SDK
  • Firebase account

Installation

  1. Clone the repository:
    git clone https://github.com/spermobak/ingredients_scanner.git
    
  2. Navigate to the project directory:
    cd ingredients_scanner
    
  3. Install dependencies:
    flutter pub get
    
  4. Firebase Setup
  • Follow the Firebase setup guide to add Firebase to your Flutter app.
  • Add your 'google-services.json' (for Android) and 'GoogleService-Info.plist' (for iOS) to the respective directories.

Running the App

  1. Run the app on an emulator or connected device:
    flutter run
    

Architecture

  • Presentation Layer: UI components and state management.
  • Domain Layer: Business logic and use cases.
  • Data Layer: Repository pattern for data handling.

Testing

  • Run unit tests:
    flutter test
    
    

Usage

  • Authenticate users with email/password or social media accounts.
  • Save and manage user preferences locally.
  • Scan product ingredients using the camera.

Contribution

Contributions are welcome! Please create an issue or submit a pull request.

License

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

Contact

For any queries, please contact [email protected].

ingredients_scanner's People

Contributors

spermobak avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.