How xyzjonas/chef works
Project type and purpose
• This is a full-stack recipe management application (“Chef”) with:
• A Vue.js single-page application (SPA) frontend under src/js/chef
• A FastAPI + SQLAlchemy backend under src/python/chef
• A relational database (PostgreSQL or SQLite) via SQLAlchemy & Alembic migrations
• Optional containerized deployment (Docker, GCP Cloud Run)
• Optional Google Cloud Storage integration for images via gcsfuse
File structure
Top-level
• Dockerfile / gcp.Dockerfile / entrypoint.sh / install.sh — containerization & startup
• alembic.ini & src/python/migrations — database migrations
• pyproject.toml — Python dependencies & entry points (CLI commands: chef, chef migrate-db)
• scripts/ — utility scripts for data/image migration
Frontend (src/js/chef)
• Standard Vue 3 + Quasar CLI structure: public/, src/ (components, views, router, stores, composables)
• Build config: vite.config.ts, uno.config.ts
Backend (src/python/chef)
• main.py — FastAPI app instantiation
• api/*.py — route definitions (categories, recipes, ingredients, tags, images)
• controllers.py — business-logic layer
• models.py + schemas.py — ORM models & Pydantic schemas
• session.py / settings.py — DB sessions & configuration
• image/ — storage abstraction & thumbnailer
• scripts/ — backend-specific migration scripts
Tests (tests/python/*)
• Coverage for controllers, models, routes, images
README for additional insights
• Confirms core tech stack: FastAPI, SQLAlchemy, Alembic, VueJS
• Usage patterns: single binary/package, Docker, GCP
• Migrations invoked via CLI or directly with Alembic
• Cloud Storage parameters (BUCKET, MNT_DIR, IMAGES_FOLDER)
Elements
– Labels: component names (e.g., “VueJS SPA”, “FastAPI API”, “Postgres DB”, “GCS Bucket”)
– Notes or annotations for key paths (e.g., “Image upload flow”, “Schema migrations via Alembic”)