Pantrie Documentation

Welcome to the Pantrie documentation! Pantrie is a modern household inventory management system designed to help you track food items, manage expiration dates, track allergens, nutritional information, and reduce food waste.

Features

• Barcode Scanning: Quickly add items by scanning barcodes, powered by Open Food Facts
• Multi-Household Support: Manage multiple households with role-based permissions
• Location Tracking: Organize items by custom locations (fridge, pantry, freezer, etc.)
• Custom Allergen Tracking: Define household-specific allergens and get automatic warnings
• Expiration Tracking: Never miss expiration dates with visual indicators
• Smart Search: Find items quickly with search and filtering
• Nutrition Information: View detailed nutrition facts from Open Food Facts database

Documentation Overview

Getting Started

Get Pantrie up and running quickly with our step-by-step guides:

• Installation - System requirements and installation instructions
• Quick Start - Get started with Pantrie in minutes
• Configuration - Configure Pantrie for your environment

User Guide

Learn how to use Pantrie's features:

• Overview - Introduction to Pantrie's user interface
• Households - Managing households and members
• Inventory Management - Adding, editing, and organizing items
• Locations - Setting up and managing storage locations
• Barcode Scanning - Using the barcode scanner feature
• Custom Allergens - Setting up allergen tracking

API Documentation

Integrate with Pantrie's RESTful API:

• Overview - API introduction and concepts
• Authentication - JWT-based authentication system
• Endpoints - Complete API endpoint reference

Development

Contributing to Pantrie or setting up a development environment:

• Architecture - System architecture and design patterns
• Backend Setup - Setting up the FastAPI backend
• Frontend Setup - Setting up the React frontend
• Database - Database schema and migrations
• Contributing - Contribution guidelines

Deployment

Deploy Pantrie to production:

• Overview - Deployment options and considerations
• Docker - Docker-based deployment guide
• Environment Variables - Configuration reference
• Reverse Proxy Setup:
  • Cloudflare Tunnels - Secure tunneling without port forwarding
  • NGINX Proxy Manager - Web-based reverse proxy management

Technology Stack

Backend

• FastAPI: Modern, high-performance Python web framework
• PostgreSQL: Reliable and powerful database
• SQLAlchemy: ORM for database operations
• Alembic: Database migration management
• Redis: Caching layer for improved performance

Frontend

• React: Modern UI library
• TypeScript: Type-safe JavaScript
• Vite: Fast development and build tooling
• Axios: HTTP client for API communication
• React Router: Client-side routing

Getting Help

If you encounter any issues or have questions:

1. Check the User Guide
2. Review the API Documentation
3. Open an issue on GitHub

License

This project is licensed under the MIT License.