From 9f1ccec8f0993adfc57b13437621a70bedc3319c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hartmut=20N=C3=B6renberg?= Date: Sun, 12 Apr 2026 14:44:13 +0200 Subject: [PATCH] docs: optimize readme landing layout for gitea --- README.md | 69 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 48 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 133db31..9586020 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,28 @@ HartOMat ist eine CAD-, Medien- und Render-Automatisierungsplattform für techni Eine ausführlichere Projektübersicht mit Screenshots gibt es in [docs/PROJECT_OVERVIEW.md](docs/PROJECT_OVERVIEW.md). +> CAD rein, Produktdaten anreichern, Output-Typ wählen, Rendern ausführen, Ergebnis kontrollieren. + +## Start Hier + +| Thema | Einstieg | +| --- | --- | +| Projektüberblick | [docs/PROJECT_OVERVIEW.md](docs/PROJECT_OVERVIEW.md) | +| Workflows | [docs/workflows/WORKFLOW_MIGRATION_PLAN.md](docs/workflows/WORKFLOW_MIGRATION_PLAN.md) | +| Architekturziel | [docs/workflows/NODE_BASED_PRODUCTION_ARCHITECTURE.md](docs/workflows/NODE_BASED_PRODUCTION_ARCHITECTURE.md) | +| Umsetzungs-Backlog | [docs/workflows/WORKFLOW_IMPLEMENTATION_BACKLOG.md](docs/workflows/WORKFLOW_IMPLEMENTATION_BACKLOG.md) | + +## Inhaltsverzeichnis + +- [Kurzüberblick](#kurzüberblick) +- [Kernfunktionen](#kernfunktionen) +- [Stack](#stack) +- [Quick Start](#quick-start) +- [Screenshots](#screenshots) +- [Workflow-System](#workflow-system) +- [Typischer Ablauf](#typischer-ablauf) +- [Projektstruktur](#projektstruktur) + ## Kurzüberblick | Bereich | Zweck | @@ -21,25 +43,24 @@ Eine ausführlichere Projektübersicht mit Screenshots gibt es in [docs/PROJECT_ - Legacy-kompatible Produktionspfade parallel zu graph-basierten Workflows - Workflow-Editor unter `/workflows` mit backend-definierten Nodes und Settings-Schemas -## Architektur - -- Frontend: React, TypeScript, Vite -- Backend: FastAPI, SQLAlchemy, Alembic, Celery -- Infrastruktur: PostgreSQL, Redis, MinIO, Docker Compose -- Rendering: Blender Worker mit GPU-Support - -## Screenshots - -![Dashboard](docs/assets/screenshots/dashboard.png) - -![Workflow Editor](docs/assets/screenshots/workflow-editor.png) - -![Product Detail](docs/assets/screenshots/product-detail.png) - -![Admin](docs/assets/screenshots/admin.png) +## Stack +| Ebene | Technologie | +| --- | --- | +| Frontend | React, TypeScript, Vite | +| Backend | FastAPI, SQLAlchemy, Alembic, Celery | +| Infrastruktur | PostgreSQL, Redis, MinIO, Docker Compose | +| Rendering | Blender Worker mit GPU-Support | + ## Quick Start +### Betriebsstatus + +- Compose-Projektname: `hartomat` +- Frontend lokal: `http://localhost:5173` +- Backend lokal: `http://localhost:8888/docs` +- MinIO Console: `http://localhost:9001` + ### Voraussetzungen - Docker und Docker Compose @@ -84,6 +105,16 @@ Das ist nur für lokale Entwicklung gedacht und sollte für jede nicht-lokale Um docker compose logs -f ``` +## Screenshots + +![Dashboard](docs/assets/screenshots/dashboard.png) + +![Workflow Editor](docs/assets/screenshots/workflow-editor.png) + +![Product Detail](docs/assets/screenshots/product-detail.png) + +![Admin](docs/assets/screenshots/admin.png) + ## Workflow-System HartOMat führt zwei Welten parallel: @@ -91,11 +122,7 @@ HartOMat führt zwei Welten parallel: - den bestehenden Legacy-Produktionspfad für sichere Rückwärtskompatibilität - den neuen node-basierten Graph-Workflow für modulare, editorfähige Produktionsketten -Die laufende Migrations- und Architekturarbeit ist hier dokumentiert: - -- [docs/workflows/WORKFLOW_MIGRATION_PLAN.md](docs/workflows/WORKFLOW_MIGRATION_PLAN.md) -- [docs/workflows/NODE_BASED_PRODUCTION_ARCHITECTURE.md](docs/workflows/NODE_BASED_PRODUCTION_ARCHITECTURE.md) -- [docs/workflows/WORKFLOW_IMPLEMENTATION_BACKLOG.md](docs/workflows/WORKFLOW_IMPLEMENTATION_BACKLOG.md) +Die laufende Migrations- und Architekturarbeit ist über die Start-Hier-Links oben erreichbar. ## Typischer Ablauf