Skip to content

gloooomed/FreshScan_AI

Repository files navigation

FreshScan AI Logo

FreshScan AI

Real-time fish freshness assessment using Edge AI. Ensure consumer safety, vendor transparency, and minimize food waste.

Report Bug · Request Feature

Stars Forks License


What it does

  • Dual-Stream AI Engine - Analyzes three biologically-significant freshness markers (gill, eye, and body) to distill into a single actionable Freshness Index (0–100).
  • Real-Time Camera Scanning - Specialized inference (< 50ms) runs directly on device, providing instant freshness grades and explainable reports.
  • Market Trust Map - Aggregates and overlays anonymized scan data onto a live, interactive map to visualize reliable vendor locations globally.

Tech Stack

Category Technology
Frontend React TypeScript
Backend FastAPI Python
AI / ML PyTorch
Core UI Vite TailwindCSS
Infra Supabase

Getting Started

git clone https://github.com/gloooomed/FreshScan_AI.git
cd FreshScan_AI
npm install

Start both the frontend and backend servers simultaneously:

npm run dev

Project Structure

FreshScan_AI/
├── backend/                  # FastAPI backend
│   ├── main.py               # Application entry point
│   └── api/                  # Endpoints (scan, history, vendors)
├── src/                      # React frontend source
│   ├── components/           # Reusable UI components
│   ├── pages/                # Features: Scanner, Dashboard, MarketMap
│   ├── lib/                  # API client and utilities
│   ├── App.tsx               # Main routing
│   └── index.css             # Tailwind configuration and design tokens
├── public/                   # Static assets (images, app icons)
├── Models/                   # Pre-compiled PyTorch models for inference
├── Training_Notebook/        # Jupyter notebooks for model training pipelines
├── package.json              # Concurrently handles frontend + backend scripts
└── DOCUMENTATION.md          # Comprehensive architecture overview

Contributing

Prerequisites

Make sure you have the following before contributing:

Requirement Version Notes
Node.js v18+ LTS recommended
Python 3.12+ Required for FastAPI / PyTorch
Git Any recent For version control

Set up your local environment using the steps in Getting Started above.

Steps

Contributions are welcome! Here's how to get involved:

  1. Fork the repository
  2. Create a branch for your feature or fix:
    git checkout -b feat/your-feature-name
  3. Make your changes and commit with a clear message:
    git commit -m "feat: add your feature description"
  4. Push to your fork:
    git push origin feat/your-feature-name
  5. Open a Pull Request against main and describe what you changed and why.

Guidelines

  • Keep PRs focused - one feature or fix per PR.
  • Follow the existing code style (TypeScript strict, Tailwind configuration, FastAPI patterns).
  • Do not commit local environments or __pycache__ artifacts.
  • For larger changes, consult DOCUMENTATION.md and open an issue first to discuss the approach.

License

MIT with Commons Clause - free for personal and educational use. Commercial use not permitted without permission. See LICENSE for details.

About

AI-powered fish freshness assessment with real-time scanning, part-specific inference, and a crowdsourced Market Trust Map.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors