Skip to content

Vertical Farm Documentation

Welcome to the comprehensive documentation for the Vertical Farm Management Platform - a full-stack IoT solution combining Next.js 15, FastAPI, Supabase, and Cloudflare Workers for smart agriculture automation.

🚀 Quick Start

New to the project? Start here based on your role:

⚡ Development Setup

# Prerequisites: Node.js 18+, Python 3.13+, Docker
# Install Supabase CLI
brew install supabase/tap/supabase

# Start development environment (recommended)
make up

# Access the application
# Frontend: http://localhost:3000
# Backend: http://localhost:8000
# Supabase Studio: http://localhost:54323

Alternative setup methods: - Docker Compose: docker-compose up --build - Manual setup: See Environment Setup - Detailed workflow: Docker Workflow Guide

📚 Documentation Structure

🎯 Getting Started

Your entry point to the platform - setup, architecture overview, and quick tutorials.

📖 Reference

Technical specifications, API documentation, and system architecture details.

📋 Guides

Task-oriented how-to guides for features, integrations, and troubleshooting.

🛠️ Development

Contribution guidelines, coding standards, and development workflows.

🚀 Operations

Production deployment, monitoring, security, and infrastructure management.

📦 Archive

Historical reports, completed migrations, and legacy documentation.

🔍 Find What You Need

I want to... Go to
Set up my development environment Quickstart Guide
Understand the system architecture Architecture Overview
Learn about the API API Reference
Deploy to production Deployment Guide
Integrate Home Assistant Home Assistant Guide
Run tests Testing Guide
Report a bug Contributing

🏗️ Platform Architecture

Tech Stack: Next.js 15 + React 19 + TypeScript + Python 3.13 + FastAPI + Supabase + Cloudflare Workers

graph TB
    A[Next.js 15 Frontend<br/>React 19 + TypeScript] --> B[Cloudflare Workers<br/>Edge Computing]
    B --> C[FastAPI Backend<br/>Python 3.13]
    C --> D[Supabase Database<br/>PostgreSQL + RLS]
    A --> E[Supabase Auth<br/>JWT + RLS]
    F[Home Assistant<br/>IoT Hub] --> C
    G[IoT Devices<br/>Sensors + Controllers] --> F
    H[Square Payments<br/>Business Operations] --> C

Project Structure: 

vertical-farm/
├── frontend/          # Next.js 15 application
├── backend/           # FastAPI Python backend  
├── cloudflare/        # Edge functions and workers
├── supabase/          # Database migrations and functions
├── scripts/           # Automation and deployment scripts
├── monitoring/        # Datadog dashboards and alerts
├── tests/             # Cross-platform integration tests
└── docs/              # This comprehensive documentation

📊 Key Features

🌱 Agriculture Management

  • Multi-tier Farm Hierarchy: Farms → Rows → Racks → Shelves organization
  • Grow Recipe System: Automated growing parameters and schedules
  • Plant Lifecycle Tracking: From seed to harvest monitoring

🏭 IoT & Automation

  • Real-time Device Control: Sensors, fans, lights, pumps integration
  • Home Assistant Integration: Comprehensive IoT device management
  • Visual Layer Overlay System: Multi-layer farm visualization
  • Automated Responses: Condition-based device automation

📊 Business Operations

  • Square Payment Integration: Revenue tracking and payment processing
  • Performance Analytics: Yield optimization and cost analysis
  • Multi-user Support: Role-based access control with RLS
  • Datadog Monitoring: Production-grade observability

💻 Technical Excellence

  • Service Layer Architecture: Mandatory pattern for all data operations
  • PWA Support: Mobile-first design with offline capabilities
  • Edge Computing: Cloudflare Workers for global performance
  • Modern Stack: Next.js 15, React 19, Python 3.13, TypeScript

🤝 Contributing to Documentation

Found something unclear or missing? See our Documentation Guidelines to contribute.

📞 Support

Last Updated: January 2025 | Active Documents: 44 | Structure Version: 2.0 | Migration Guide