Skip to content

GDIPSA-Team2/ecoplate

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

528 Commits
.github
.github
 
 
backend
backend
 
 
deploy
deploy
 
 
docs/usecase
docs/usecase
 
 
e2e
e2e
 
 
ecolocker/src
ecolocker/src
 
 
frontend
frontend
 
 
recommendation-engine
recommendation-engine
 
 
security-reports
security-reports
 
 
security
security
 
 
testimg/receipts
testimg/receipts
 
 
.dockerignore
.dockerignore
 
 
.gitignore
.gitignore
 
 
.gitleaks.toml
.gitleaks.toml
 
 
.pre-commit-config.yaml
.pre-commit-config.yaml
 
 
.trufflehog.yaml
.trufflehog.yaml
 
 
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 
bun.lock
bun.lock
 
 
capacitor.config.ts
capacitor.config.ts
 
 
docker-compose.yml
docker-compose.yml
 
 
entrypoint.sh
entrypoint.sh
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 
pyproject.toml
pyproject.toml
 
 
sonar-project.properties
sonar-project.properties
 
 

Repository files navigation

EcoPlate

EcoPlate is a sustainability-focused food management platform that helps reduce food waste through smart inventory tracking, community marketplace, and gamification. We address the global food waste crisis by transforming how households manage their food consumption, turning sustainability into an engaging, rewarding experience.

Our platform combines AI-powered receipt scanning for effortless food tracking, a peer-to-peer marketplace for redistributing surplus food locally, and a gamified reward system that turns eco-friendly actions into points, badges, and leaderboard achievements. By providing real-time visibility into food inventory, expiration alerts, and CO₂ emission tracking, we empower users to make informed decisions that reduce waste and environmental impact.

EcoPlate goes beyond individual benefits—it builds community-driven sustainability networks where neighbors can share resources, rescue food, and collectively reduce waste. Whether you're scanning grocery receipts, listing near-expiry items, or tracking your environmental savings, every action contributes to a larger movement toward zero-waste living and meaningful climate action.

System Architecture

flowchart TB
    subgraph Client["Client Layer"]
        WEB["Web Browser"]
        ANDROID["Android App"]
    end

    subgraph Frontend["Frontend (React + Vite)"]
        REACT["React 19 + TypeScript"]
        CAPACITOR["Capacitor"]
        TAILWIND["Tailwind CSS + shadcn/ui"]
    end

    subgraph Backend["Backend (Bun)"]
        API["REST API Server"]
        AUTH["JWT Auth Middleware"]
        ROUTES["Route Handlers"]
    end

    subgraph Services["External Services"]
        OPENAI["OpenAI API"]
        RECOMMEND["Recommendation Engine"]
    end

    subgraph Database["Database Layer"]
        SQLITE["SQLite"]
        DRIZZLE["Drizzle ORM"]
    end

    WEB --> REACT
    ANDROID --> CAPACITOR
    CAPACITOR --> REACT
    REACT --> TAILWIND
    REACT -->|HTTP/REST| API
    API --> AUTH
    AUTH --> ROUTES
    ROUTES --> DRIZZLE
    DRIZZLE --> SQLITE
    ROUTES -->|Receipt Scan| OPENAI
    ROUTES -->|Product Suggestion| RECOMMEND
Loading

Features

MyFridge

  • Track food items with CO2 emission data
  • Scan grocery receipts with AI (OpenAI Vision)
  • Log consumption, waste, and extract image data via OpenAI Vision

Marketplace

  • List near-expiry food items for sale or free
  • Browse and reserve listings from others
  • Complete actions to earn sustainability points
  • AI-powered product recommendations
  • In-app messaging between buyers and sellers

EcoBoard & EcoPoints

  • Earn points for sustainable actions
  • Track streaks and sustainability metrics
  • Unlock badges for achievements
  • View CO2 savings and waste reduction rate
  • Community leaderboard

User Flow

flowchart TD
    START((Start)) --> AUTH{Authenticated?}
    AUTH -->|No| LOGIN[Login/Register]
    LOGIN --> DASHBOARD
    AUTH -->|Yes| DASHBOARD[Dashboard]

    DASHBOARD --> FRIDGE[MyFridge]
    DASHBOARD --> MARKET[Marketplace]
    DASHBOARD --> ECO[EcoBoard]

    subgraph MyFridge["MyFridge Module"]
       FRIDGE --> ADD[Add Product]
       FRIDGE --> SCAN[Scan Receipt]
       FRIDGE --> VIEW[Track Consumption & Waste]
   
       SCAN -->|AI Processing| PARSE[Parse Items]
       PARSE --> ADD
   
       VIEW --> CONSUME{Action?}
       CONSUME -->|Consumed| POINTS_CONSUMED[+5 Points]
       CONSUME -->|Shared| POINTS_SHARED[+10 Points]
       CONSUME -->|Sold| POINTS_SOLD[+8 Points]
       CONSUME -->|Wasted| POINTS_WASTED[-3 Points]
    end

    end

    subgraph Marketplace["Marketplace Module"]
        MARKET --> BROWSE[Browse Listings]
        MARKET --> CREATE[Create Listing]
        MARKET --> EDIT[Edit Listing]
        MARKET --> Delete[Delete Listing]
        MARKET --> MapView[Geolocation]
        CONTACT --> MESSAGE[Message Seller]
        CREATE --> PRODUCT[Get Product Recommendation]
        
        MARKET --> COMPLETE[Complete Listing (Sold)]
        COMPLETE --> POINTS_SOLD[+8 Points]
    end

    subgraph Gamification["Gamification Module"]
        ECO --> STATS[View Stats]
        ECO --> BADGES[View Badges]
        ECO --> LEADER[Leaderboard]
        POINTS1 & POINTS2 & POINTS3 & POINTS4 --> STATS
        STATS --> UNLOCK{Badge Unlock?}
        UNLOCK -->|Yes| BADGES
    end
Loading

Database Schema

erDiagram
   Badges {
      int id PK
      string code FK
      string name
      string description
      string category
      int awarded
   }

   UserBadges {
      int id PK
      int userid FK
      int badge_id FK
      timestamp earned_at
   }

   Products {
      int id PK
      int userid FK
      string productName
      string category
      float quantity
      float unit_price
      date purchase_date
      string description
      float co2_emission
   }

   User {
      int id PK
      string email
      string password_hash
      string name
      string avatar_url
      timestamp created_at
      timestamp updated_at
      string user_location
   }

   ImageListing {
      int id PK
      string description
      string category
      float price
      int has
      float original_price
      date expiry_date
      string pickup_location
      string status
      timestamp created_at
      timestamp completed_at
   }

   Conversation {
      int id PK
      int listing_id
      int seller_id FK
      int buyer_id FK
   }

   Message {
      int id PK
      int conversation_id
      int user_id FK
      string message_text
      timestamp created_at
   }

   User ||--o{ UserBadges : "has badges"
   Badges ||--o{ UserBadges : "awarded to users"
   User ||--o{ Products : "owns"
   User ||--o{ Conversation : "sells as seller"
   User ||--o{ Conversation : "buys as buyer"
   Conversation ||--o{ Message : "contains"
   User ||--o{ Message : "writes"
   ImageListing ||--o{ Conversation : "listed in"
   ImageListing ||--|| User : "belongs to (has)"
Loading

Tech Stack

Layer Technology
Runtime Bun
Database SQLite (via bun:sqlite)
ORM Drizzle ORM
Backend Bun native HTTP server
Frontend React 19 + TypeScript
Build Tool Vite
Styling Tailwind CSS + shadcn/ui
Mobile Capacitor (iOS & Android)
Auth JWT (jose library)
Validation Zod

API Authentication Flow

sequenceDiagram
    participant C as Client
    participant A as API Server
    participant DB as Database

    Note over C,DB: Registration
    C->>A: POST /auth/register
    A->>DB: Create user + hash password
    DB-->>A: User created
    A->>A: Generate JWT tokens
    A-->>C: { accessToken, refreshToken }

    Note over C,DB: Login
    C->>A: POST /auth/login
    A->>DB: Verify credentials
    DB-->>A: User data
    A->>A: Generate JWT tokens
    A-->>C: { accessToken, refreshToken }

    Note over C,DB: Protected Request
    C->>A: GET /myfridge/products<br/>Authorization: Bearer {token}
    A->>A: Verify JWT
    A->>DB: Query products
    DB-->>A: Products list
    A-->>C: [products]

    Note over C,DB: Token Refresh
    C->>A: POST /auth/refresh
    A->>DB: Verify refresh token
    A->>A: Generate new tokens
    A-->>C: { accessToken, refreshToken }
Loading

Receipt Scanning Flow

sequenceDiagram
    participant U as User
    participant F as Frontend
    participant B as Backend
    participant AI as OpenAI Vision

    U->>F: Upload receipt image
    F->>F: Convert to Base64
    F->>B: POST /myfridge/receipt/scan
    B->>AI: Analyze image
    AI-->>B: Extracted items JSON
    B-->>F: { items: [...] }
    F->>U: Show parsed items
    U->>F: Confirm items
    F->>B: POST /myfridge/products (batch)
    B-->>F: Products created
    F->>U: Success + points awarded
Loading

Project Structure

├── backend/
│   ├── src/
│   │   ├── index.ts           # Main server entry
│   │   ├── routes/            # API route handlers
│   │   │   ├── auth.ts        # Authentication endpoints
│   │   │   ├── myfridge.ts    # Fridge management endpoints
│   │   │   ├── marketplace.ts # Marketplace endpoints
│   │   │   └── gamification.ts# Gamification endpoints
│   │   ├── middleware/        # Auth middleware
│   │   ├── db/
│   │   │   ├── schema.ts      # Drizzle ORM schema
│   │   │   ├── migrations/    # Database migrations
│   │   │   └── seed.ts        # Seed data
│   │   └── utils/             # Utilities
│   ├── public/                # Built frontend assets
│   └── package.json
│   └── .env                  # Web env variables
├── frontend/
│   ├── src/
│   │   ├── components/        # React components
│   │   ├── pages/             # Page components
│   │   ├── contexts/          # React contexts
│   │   ├── services/          # API client + Capacitor utils
│   │   ├── hooks/             # Custom hooks
│   │   └── lib/               # Utilities
│   ├── android/               # Android native project (after cap add)
│   ├── capacitor.config.ts    # Capacitor configuration
│   ├── vite.config.ts
│   └── package.json
│   └── .env.mobile            # Mobile env variables
├── scripts/                   # Start/stop/build scripts
├── package.json               # Root workspace
└── .env.example               # Environment template
├── recommendation-engine/
│   ├── app.py                # Recommendation engine (Flask or FastAPI)
│   ├── Dockerfile            # Dockerfile for deployment
│   └── requirements.txt      # Python dependencies
│   └── .env.ml               # ML env variables

Prerequisites

  • Bun v1.0 or higher

Quick Start

Using Scripts

Windows (PowerShell):

# Start both frontend and backend
.\scripts\start-all.ps1

# Stop all servers
.\scripts\stop-all.ps1

Mac/Linux:

# Start both frontend and backend
./scripts/start-all.sh

# Stop all servers
./scripts/stop-all.sh

Manual Setup

  1. Install dependencies:

    bun install

  2. Set up environment:

    cp .env.ml .env.ml

  3. Run database migrations:

    bun run db:migrate
bun run db:seed

  4. Start development servers:

    # Terminal 1: Backend
bun run dev:backend

# Terminal 2: Frontend
bun run dev:frontend

  5. Open the app:

Production Build

Windows:

.\scripts\build.ps1

Mac/Linux:

./scripts/build.sh

Then start the production server:

cd backend
bun run src/index.ts

The server will serve both the API and the built frontend on http://localhost:3000.

Mobile Apps (Android)

The app uses Capacitor to build native Android apps.

Prerequisites

  • Android: Android Studio with SDK 33+

Building for Android

Windows/Mac/Linux:

./scripts/build-android.sh
# or on Windows:
.\scripts\build-android.ps1

Then open in Android Studio:

cd frontend && bunx cap open android

Or build APK from command line:

cd frontend/android && ./gradlew assembleDebug

APK location: frontend/android/app/build/outputs/apk/debug/app-debug.apk

Known Issues & Fixes

Our project automatically handles Capacitor 6.x + Android Gradle Plugin 9.0+ compatibility. The ProGuard configuration is fixed via:

  1. Gradle build override (primary) - Configured in frontend/android/build.gradle
  2. patch-package (fallback) - For complex patches
  3. Postinstall script (safety net) - Runs after bun install

For new team members: Just run bun install and the fixes apply automatically.

For troubleshooting: See docs/android-build-patching.md for detailed documentation.

Optional - Building for iOS (macOS only)

./scripts/build-ios.sh

Then open in Xcode:

cd frontend && bunx cap open ios

Or open directly: frontend/ios/App/App.xcworkspace

Mobile Configuration

Edit frontend/.env.mobile to set the production API URL:

VITE_API_URL=https://api.ecoplate.app/api/v1

For development, the app connects to localhost. For production builds, update the API URL and rebuild.

Capacitor Commands

cd frontend

# Sync web assets to native projects
bun run cap:sync

# Open native IDE
bun run cap:open:ios      # Opens Xcode
bun run cap:open:android  # Opens Android Studio

# Build for mobile
bun run build:mobile      # Build and sync both platforms
bun run build:ios         # Build and copy to iOS
bun run build:android     # Build and copy to Android

Environment Variables

Variable Description Required
PORT Server port (default: 3000) No
JWT_SECRET Secret key for JWT signing Yes (for production)
OPENAI_API_KEY OpenAI API key for receipt scanning No

API Endpoints

Authentication

Method Endpoint Description
POST /api/v1/auth/register Register new user
POST /api/v1/auth/login Login
POST /api/v1/auth/refresh Refresh access token
POST /api/v1/auth/logout Logout

MyFridge

Method Endpoint Description
GET /api/v1/myfridge/products List all products
POST /api/v1/myfridge/products Add product
GET /api/v1/myfridge/products/:id Get product
PATCH /api/v1/myfridge/products/:id Update product
DELETE /api/v1/myfridge/products/:id Delete product
POST /api/v1/myfridge/products/:id/consume Log consumption
POST /api/v1/myfridge/receipt/scan Scan receipt (AI)

Marketplace

Method Endpoint Description
GET /api/v1/marketplace/listings Browse active listings
GET /api/v1/marketplace/listings/nearby Get nearby map listings
GET /api/v1/marketplace/my-listings Get user's own listings
GET /api/v1/marketplace/listings/:id Get single listing details
POST /api/v1/marketplace/listings Create new listing
PATCH /api/v1/marketplace/listings/:id Update existing listing
DELETE /api/v1/marketplace/listings/:id Delete listing
POST /api/v1/marketplace/listings/:id/complete Mark as sold/completed

Gamification

Method Endpoint Description
GET /api/v1/gamification/dashboard Get dashboard data
GET /api/v1/gamification/points Get points details
GET /api/v1/gamification/badges Get all badges
GET /api/v1/gamification/metrics Get sustainability metrics
GET /api/v1/gamification/leaderboard Get leaderboard

Scripts Reference

Script Description
start-backend.ps1 / .sh Start backend server with dependencies
stop-backend.ps1 / .sh Stop backend server
start-frontend.ps1 / .sh Start frontend dev server with dependencies
stop-frontend.ps1 / .sh Stop frontend dev server
start-all.ps1 / .sh Start all servers (backend, frontend, recommendation)
stop-all.ps1 / .sh Stop all servers
build.ps1 / .sh Build web app for production
build-android.ps1 / .sh Build Android app
build-ios.sh Build iOS app (macOS only)

Database

The application uses SQLite stored at backend/ecoplate.db. The schema includes:

  • Users: users
  • MyFridge: products, product_interaction
  • Marketplace: marketplace_listings, image_listing, conversation, message
  • Gamification: user_points, badges, user_badges

License

MIT

About

A sustainability-focused food management platform that helps users reduce food waste through smart inventory tracking, a community marketplace, and gamification rewards.

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

0 watching

Forks

3 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 73.5%
  • HTML 20.9%
  • Python 5.1%
  • CSS 0.2%
  • Shell 0.1%
  • Dockerfile 0.1%
  • JavaScript 0.1%