🍎 A Flutter (Android) app dedicated to users with food allergies. 📱 Input your allergens, take a photo of an ingredient label, and let the app determine if you can eat that food product. Saves you the hassle of reading long and tiny text!
- Quick Allergen Scanning: Efficiently check an ingredients label for allergens.
- Customizable Allergen List: Add and remove your allergens as needed.
- Color-Coded Results: Clear, color-coded messages to indicate safety.
- Simple UI: A simple and intuitive user interface for an easy user experience.
Here are some screenshots demonstrating different features of the app in order of how it's used (left to right):
To get started with this project, follow these steps:
-
Clone the Repository:
git clone https://github.com/ananya-nadendla/can_i_eat_that.git
-
Navigate to the Project Directory:
cd can_i_eat_that
-
Install Dependencies:
Make sure you have Flutter installed. Then, run:
flutter pub get
-
Set Up Environment Variables:
Follow the instructions in the Environment Configuration section to set up your
.env
file. -
Run the App:
flutter run
This project uses an environment file (.env
) to store API Keys for security purposes.
-
Copy the Sample File:
Create a copy of the
.env_sample
file and name it.env
in the root directory of your project. -
Sign Up For Merriam-Webster API
Sign Up Link: https://dictionaryapi.com/register/index (its free!)
- For "Request API Key (1)", choose "Collegiate Dictionary" from dropdown
- For "Request API Key (2)", choose "Medical Dictionary" from dropdown
-
Add Your API Keys:
Open the
.env
file and replace the placeholder values with your actual API keys. For example:# Your Merriam-Webster Collegiate API Key API_KEY_MERRIAM_WEBSTER_COLLEGIATE_DICTIONARY=your_actual_collegiate_api_key # Your Merriam-Webster Medical API Key API_KEY_MERRIAM_WEBSTER_MEDICAL_DICTIONARY=your_actual_medical_api_key
Privacy is important. The can_i_eat_that
app takes your images of ingredient labels solely for the purpose of identifying allergens.
-
Temporary Storage: Images are temporarily stored only during the scanning process. They are used to process and analyze ingredient labels and are not retained beyond this process. Images are not stored or saved long-term.
-
Third-Party Sharing:
- Our app uses the Google ML Kit for image processing and analysis. Images are sent to Google ML Kit APIs to perform necessary tasks such as text recognition.
- Google’s Privacy Practices: We do not control how Google handles the data. Please refer to Google’s Privacy Policy for details on how your data is managed and protected.
- Allergen Storage: The Can I Eat That app saves the user’s allergens locally on the device. This data is used to personalize the allergen detection process and is not shared with any third parties. Users can manage or delete their stored allergens by using the Manage Allergies button on the home page, which leads to the allergies page.