Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/EstefanoARG/FridgeRadar/llms.txt

Use this file to discover all available pages before exploring further.

FridgeRadar helps households eliminate food waste by tracking every item in the pantry with a real-time color-coded freshness system. Connect a FastAPI backend to a React frontend, add your products, and FridgeRadar will alert you before food expires, suggest recipes based on what needs to be used first, and generate waste reports over time.

Quickstart

Get the backend and frontend running locally in under 10 minutes.

Core Concepts

Learn how the traffic-light freshness system, households, and inventory work.

API Reference

Explore every REST endpoint — auth, inventory, recipes, alerts, and more.

Configuration

All environment variables for the backend, JWT, CORS, and the scheduler.

What FridgeRadar Does

FridgeRadar organizes your pantry into Households → Zones → Shelves → Inventory items. Each item carries a purchase date and optional expiry date. A background scheduler recalculates a four-state freshness indicator — verde, amarillo, rojo, vencido — every night at midnight and pushes expiry alerts to each user’s inbox every morning at 8 AM.
1

Create your account

Register via POST /api/v1/auth/register and log in to receive a JWT bearer token.
2

Set up a household

Create a household (POST /api/v1/hogares), then add zones and shelves to model your physical storage space.
3

Add inventory items

Post products to POST /api/v1/inventario/hogar/{id_hogar} with purchase and expiry dates. The semáforo state is calculated automatically.
4

Get recipe suggestions

Call GET /api/v1/tengo-hambre/{id_hogar} to receive recipes ranked by how well they use ingredients that are about to expire.

Key Features

Semáforo Freshness System

Four-state color indicator automatically updated daily for every inventory item.

Multi-Household Support

Manage multiple households, invite members, and keep inventories separate.

Tengo Hambre Engine

Recipe suggestions that prioritize your most at-risk ingredients.

Waste Tracking

Log discarded food and view per-household waste metrics over time.

Shopping Lists

Create and manage shared shopping lists with per-item quantities.

Automated Alerts

Daily background tasks generate expiry notifications without manual intervention.

Build docs developers (and LLMs) love