OpenKitchenPlanner (OKP)

English | Deutsch

---

🇬🇧 English: Project Overview

OpenKitchenPlanner is a web-based planning platform for carpentry workshops and kitchen studios. It combines room modeling, catalog-based CAD workflows, pricing, quote generation, and production export pipelines in a single monorepo — with a Fluent 2 ribbon UI and full MCP integration.

🚀 Status

• Version: 0.1.3 (2026-03-10)
• Build: Green — 165 frontend tests, full tsc + vite build clean.
• UI: Fluent 2 Ribbon Shell across all areas (Kanban, Editor, Settings). All pages migrated to makeStyles/tokens.
• Backend: Fastify REST API + PostgreSQL (Prisma).
• 3D Preview: WebGPU renderer with automatic WebGL-2 fallback; OffscreenCanvas Worker rendering (Chromium) keeps main thread free.
• Plugins: 11 registered plugins fully wired: presentation, viewer-export, tischler, daylight, materials, stairs, multilevel-docs, asset-library, feng-shui, raumakustik, survey-import.

🛠 Core Capabilities

• Modeling: Polygonal rooms with wall constraints, sloped ceilings, curved walls, multi-floor support.
• Business: Pricing engine, Bill of Materials (BOM), PDF quote generation with custom branding.
• Project Management: Kanban board, Gantt timeline, Document Management (DMS), CRM contacts.
• Production: Automated cutlists, CNC nesting (DXF export), production order management.
• Interoperability: IFC (BIM), DXF/DWG, SketchUp import, GLTF/GLB export for AR/VR.
• AI Integration: Native MCP (Model Context Protocol) support for AI-assisted planning.
• Plugins: Modular plugin system with tenant-scoped activation (Feng Shui, Acoustic Analysis, Site Survey, Presentation, Daylight, and more).

🏗 Development Phases

• Phase 1–4 (Sprints 0–98): MVP → multi-tenancy → industry features → stabilization.
• Phase 5 (Sprints 99–116): Workflow engine, masterdata sync, mobile client, Fluent 2 migration, Ribbon Shell, plugin infrastructure hardening.
• Phase 6 (Sprints 117–120+): CAD/BIM Interop modernization, WebGPU renderer, OffscreenCanvas Worker rendering.

---

📦 Installation (EN)

Prerequisites

• Node.js: 20.x or 22.x (LTS)
• npm: 10+
• Database: PostgreSQL 15+

Option A: Docker

git clone https://github.com/DKFuH/OKP.git
cd OKP
docker-compose up -d --build
docker-compose exec api npm run db:push
npm install
npm run dev --workspace planner-frontend

Option B: Local (e.g. Laragon)

1. Create a PostgreSQL database, e.g. okp with user okp / password okp_dev.
2. Create planner-api/.env:

   DATABASE_URL="postgresql://okp:okp_dev@localhost:5432/okp"
   PORT=3000
   HOST=0.0.0.0
   FRONTEND_URL=http://localhost:5173

3. Run:

   npm install
   npm run db:push --workspace planner-api
   # Terminal 1
   npm run dev --workspace planner-api
   # Terminal 2
   npm run dev --workspace planner-frontend

4. Open http://localhost:5173

---

🇩🇪 Deutsch: Projektübersicht

OpenKitchenPlanner ist eine webbasierte Planungsplattform für Schreinereien und Küchenstudios. Sie vereint Raumplanung, Katalog-CAD, Kalkulation, Angebotserstellung und Produktions-Export in einem Monorepo — mit Fluent 2 Ribbon-UI und vollständiger MCP-Integration.

🚀 Status

• Version: 0.1.3 (10.03.2026)
• Build: Grün — 165 Frontend-Tests, tsc + vite sauber.
• UI: Fluent 2 Ribbon-Shell in allen Bereichen (Kanban, Editor, Einstellungen). Alle Seiten auf makeStyles/tokens migriert.
• Backend: Fastify REST-API + PostgreSQL (Prisma).
• 3D-Preview: WebGPU-Renderer mit automatischem WebGL-2-Fallback; OffscreenCanvas Worker-Rendering (Chromium) entlastet den Main-Thread.
• Plugins: 11 registrierte Plugins vollständig verdrahtet: presentation, viewer-export, tischler, daylight, materials, stairs, multilevel-docs, asset-library, feng-shui, raumakustik, survey-import.

🛠 Kernfunktionen

• Modellierung: Polygonale Räume mit Wand-Constraints, Dachschrägen, gebogenen Wänden, Mehr-Ebenen.
• Business: Kalkulations-Engine, Stücklisten (BOM), PDF-Angebote mit Firmenbranding.
• Projektmanagement: Kanban-Board, Gantt-Timeline, Dokumentenmanagement (DMS), Kontakte/CRM.
• Produktion: Zuschnittlisten, CNC-Nesting (DXF-Export), Produktionsaufträge.
• Interop: IFC (BIM), DXF/DWG, SketchUp-Import, GLTF/GLB-Export für AR/VR.
• KI-Integration: Native MCP-Unterstützung (Model Context Protocol) für KI-gestützte Planung.
• Plugins: Modulares Plugin-System mit Mandanten-Aktivierung (Feng Shui, Raumakustik, Aufmaß-Import, Präsentation, Tageslicht u. v. m.).

---

📦 Installation (DE)

Voraussetzungen

• Node.js: 20.x oder 22.x (LTS)
• npm: 10+
• Datenbank: PostgreSQL 15+

Option A: Docker

git clone https://github.com/DKFuH/OKP.git
cd OKP
docker-compose up -d --build
docker-compose exec api npm run db:push
npm install
npm run dev --workspace planner-frontend

Option B: Lokal (z. B. Laragon)

1. PostgreSQL-Datenbank anlegen, z. B. yakds / User yakds / Passwort yakds_dev (oder okp/okp_dev/okp).
2. planner-api/.env anlegen:

   DATABASE_URL="postgresql://yakds:yakds_dev@localhost:5432/yakds"
   PORT=3000
   HOST=0.0.0.0
   FRONTEND_URL=http://localhost:5173

3. Starten:

   npm install
   npm run db:push --workspace planner-api
   # Terminal 1
   npm run dev --workspace planner-api
   # Terminal 2
   npm run dev --workspace planner-frontend

4. http://localhost:5173 öffnen

---

📂 Monorepo-Struktur

OKP/
├── planner-frontend/      # React + Fluent 2 + Konva/Three.js
├── planner-api/           # Fastify REST-API & MCP-Server
├── shared-schemas/        # Gemeinsame Domain-Typen (Zod)
├── interop-cad/           # DXF/DWG Import & Export
├── interop-sketchup/      # SKP-Import
└── Docs/                  # Architektur, Roadmap, Sprint-Docs

🧪 Tests

# Alle Tests
npm test

# Nur Frontend
npm run test --workspace planner-frontend

⚖️ Lizenz / License

Copyright © 2026 Tischlermeister Daniel Klas. Licensed under the Apache License 2.0.