Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/1mindlabs/mivro-web-app

Web Application for Mivro
https://github.com/1mindlabs/mivro-web-app

algolia-search hacktoberfest nextjs tailwind-css typescript

Last synced: 3 days ago
JSON representation

Web Application for Mivro

Host: GitHub
URL: https://github.com/1mindlabs/mivro-web-app
Owner: 1MindLabs
License: mit
Created: 2024-08-31T13:39:43.000Z (27 days ago)
Default Branch: main
Last Pushed: 2024-08-31T13:40:50.000Z (27 days ago)
Last Synced: 2024-09-25T00:29:24.017Z (3 days ago)
Topics: algolia-search, hacktoberfest, nextjs, tailwind-css, typescript
Language: Dart
Homepage: https://mivro.org
Size: 2.62 MB
Stars: 4
Watchers: 0
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

## Project Description

The app supports barcode scanning for foods, drinks, cosmetics, medicines, and pet foods. It provides detailed ingredient information, categorizes nutrients into positive and negative (either generally or based on user-specific health data), identifies associated health risks, and suggests alternatives using an AI recommendation engine.

### Key Features

- **Search Engine**: Easily find products without barcode scanning, with upcoming support for image and live product recognition.
- **Meal Tracker**: Monitor your daily nutritional intake by scanning product barcodes, allowing you to easily track and manage your meals.
- **Marketplace**: Discover and purchase for healthier alternatives from our trusted partners.
- **Browser Extension**: Integrate app features seamlessly into your online shopping experience.

Additionally, the app includes a Recipe Chatbot for personalized recipe recommendations and an Account Activity feature to track your scan history, searches, and payments.

## System Architecture

System Architecture

---

1. **Barcode Scan**: Utilizes the `zxing_flutter` library to capture barcode input from the user via the Flutter app. The scanned barcode is then sent to the Django server for further processing.

2. **Text Search**: Accepts text input from the user through the Flutter app for product lookup. This input is forwarded to the Django server to query the Firestore database for relevant product information.

3. **Django Server**: Serves as the central backend server responsible for user authentication, data cleaning, integration with the Gemini API, and interaction with Google Firebase services.

4. **OpenFoodFacts API**: Fetches raw, detailed information about products based on barcode or text search inputs. This API provides comprehensive ingredient and nutritional data, including metadata such as name, brand, and more.

5. **Gemini API**: Analyzes data from the OpenFoodFacts API, sorting nutrients into positive and negative categories, flagging potential health risks, and offering product recommendations.

6. **Firestore Database**: Stores processed product information, facilitating quick lookups for both the browser extension and the Flutter app. If no barcode is detected, it searches the database for relevant details.

7. **Flutter App**: Cross-platform mobile application enabling users to scan barcodes for offline shopping, access features such as a recipe chatbot, meal tracker for monitoring nutritional intake, and a marketplace for healthy products.

8. **Browser Extension**: Extends the features of the Flutter app to the user's online shopping experience, allowing product lookups using our search engine directly within the browser.

## Getting Started

Follow these steps to set up and run the Mivro software on your local machine, or you can watch the [demo video](https://youtube.com/watch?v=ToXUq-NSkUg).

### Prerequisites

- [Python >= 3.11.9](https://python.org/ftp/python/3.11.9/python-3.11.9-amd64.exe)
- [Node.js >= 20.14.0](https://nodejs.org/dist/v20.14.0/node-v20.14.0-x64.msi)
- [Flutter SDK >= 3.22.3](https://storage.googleapis.com/flutter_infra_release/releases/stable/windows/flutter_windows_3.22.3-stable.zip)

### Installation

#### Python Server

1. **Fork the repository**:
- Go to the [Mivro repository on GitHub](https://github.com/SpaceTesla/Mivro) and click the "Fork" button at the top right corner to create a copy under your GitHub account.

2. **Clone the repository to your local machine**:
```shell
git clone https://github.com//Mivro.git
```

3. **Navigate to the project directory**:
```shell
cd Mivro
```

4. **Create a virtual environment (optional but recommended)**:
```shell
python -m venv .venv
```

5. **Activate the virtual environment**:
- **Windows**:
```shell
.venv\Scripts\activate
```
- **macOS and Linux**:
```shell
source .venv/bin/activate
```

6. **Install the project dependencies**:
```shell
pip install -r requirements.txt
```

7. **Set up the configuration files**:
- Create a `.env` file in the project root directory with the following template:
```ini
FLASK_SECRET_KEY=your_secret_key
GEMINI_API_KEY=your_gemini_api_key
```

- Create a `firebase-adminsdk.json` file in the project root directory with the following template:
```json
{
"type": "service_account",
"project_id": "your_project_id",
"private_key_id": "your_private_key_id",
"private_key": "-----BEGIN PRIVATE KEY-----\nYOUR_PRIVATE_KEY\n-----END PRIVATE KEY-----\n",
"client_email": "your_client_email",
"client_id": "your_client_id",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/your_client_email",
"universe_domain": "googleapis.com"
}
```

8. **Run the Python application**:
```shell
python python-app/app.py
```

#### Browser Extension

1. **Set up the Chrome extension**:
- Open Chrome and go to `chrome://extensions`.
- Enable "Developer mode" (top right corner).
- Click "Load unpacked" (top left corner).
- Select the `browser-extension` folder in the Mivro repository.

2. **Using the Browser Extension**:
- Navigate to any of the following supported websites:
- https://www.bigbasket.com
- https://www.blinkit.com
- https://www.swiggy.com
- https://www.zeptonow.com
- https://www.jiomart.com
- https://www.amazon.com
- https://www.flipkart.com

- Select and open any product. The browser extension will appear on the right side of the screen. Click on the extension icon to access detailed information.

#### Flutter Application

1. **Navigate to the flutter-app directory**:
```shell
cd flutter-app
```

2. **Get Flutter dependencies**:
```shell
flutter pub get
```

3. **Prepare your device**:
- Ensure an Android device is connected and debugging is enabled, or start an Android emulator.

4. **Run the Flutter app**:
```shell
flutter run
```

## License

This project is licensed under the [MIT License](https://github.com/SpaceTesla/Mivro/blob/main/LICENSE).

## Authors

[Areeb Ahmed](https://github.com/areebahmeddd) - [Shivansh Karan](https://github.com/SpaceTesla) - [Shashwat Kumar](https://github.com/shashwat6204) - [Rishi Chirchi](https://github.com/rishichirchi)