Skip to content

Repositories

GreenThumb uses a multi-repository architecture for better separation of concerns and scalability.

Repository Structure

graph TB
    ORG[GreenThumbProject]

    CORE[greenthumb-core]
    RASP5[rasp5]
    CLIENT[microcontroller-api-client]
    DB[database]
    CRON[cron]
    DOCS[docs]
    RESEARCH[research]
    GITHUB[.github]

    ORG --> CORE
    ORG --> RASP5
    ORG --> CLIENT
    ORG --> DB
    ORG --> CRON
    ORG --> DOCS
    ORG --> RESEARCH
    ORG --> GITHUB

    CORE -->|imported by| RASP5
    CORE -->|imported by| CLIENT
    CORE -->|imported by| CRON
    DB -->|schemas used by| RASP5

Core Repositories

greenthumb-core

Private | Python Package

Shared library containing:

  • SQLModel database definitions
  • Database utilities (engine, session)
  • Raspberry Pi 5 hardware interfaces
  • Sensor and actuator drivers
  • CRUD router generation for FastAPI
# Install in other projects
pip install git+https://${GH_PAT}@github.com/GreenThumbProject/greenthumb-core.git

rasp5

Private | Docker Compose Deployment

Main Raspberry Pi 5 deployment:

  • Docker Compose configuration
  • Microcontroller API service (hardware control)
  • Database initialization scripts
  • Makefile commands

microcontroller-api-client

Private | Controller Scripts

HTTP-based client for greenhouse control:

  • controller script: Sense-Think-Act loop
  • Future: Additional control scripts
  • Future: ML agent implementations

database

Private | SQL Schemas

Database management:

  • PostgreSQL schemas
  • Seed data
  • Future: Alembic migrations

cron

Private | Scheduled Tasks

Cron jobs and scheduled tasks:

  • Cloud sync (Supabase)
  • Image upload (Cloudflare R2)
  • Database cleanup

Documentation & Research

docs

Public | MkDocs Site

This documentation website:

  • Installation guides
  • Architecture docs
  • API reference
  • Project summaries (EN/PT)

Deployed to: greenthumbproject.github.io/docs

research

Private | Academic Materials

Research project documents:

  • PIBITI proposal
  • Research paper (PT/EN)
  • References and notes

.github

Public | Organization Profile

Organization-level files:

  • Profile README
  • AI context file
  • Shared issue templates

Future Repositories

Repository Purpose
greenthumb-esp32 ESP32 library (if modular)
cloud Supabase/Cloudflare integration
ml Machine learning models and agents

Naming Convention

  • greenthumb-* - Only for installable packages/libraries
  • Short names - For applications and deployments

Examples:

  • ✅ greenthumb-core (Python package)
  • ✅ rasp5 (deployment)
  • ✅ microcontroller-api-client (client scripts)
  • ✅ database (not an installable package)
  • ❌ greenthumb-database (not a package)