From 4b0e2ee724702a9841f6a1faf9fb553d67ebc669 Mon Sep 17 00:00:00 2001 From: knso Date: Sun, 24 May 2026 23:35:04 +0000 Subject: [PATCH] Initial commit --- .gitignore | 8 ++++++ .webklar-preview.json | 7 +++++ README.md | 60 +++++++++++++++++++++++++++++++++++++++++++ index.html | 43 +++++++++++++++++++++++++++++++ 4 files changed, 118 insertions(+) create mode 100644 .gitignore create mode 100644 .webklar-preview.json create mode 100644 README.md create mode 100644 index.html diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..245140a --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +node_modules/ +dist/ +out/ +build/ +.env +.env.local +.DS_Store +*.log diff --git a/.webklar-preview.json b/.webklar-preview.json new file mode 100644 index 0000000..1b12f36 --- /dev/null +++ b/.webklar-preview.json @@ -0,0 +1,7 @@ +{ + "enabled": true, + "type": "static", + "branch": "main", + "displayName": "Webklar Preview Vorlage", + "subdomain": "webklar-preview-template" +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..38ed6ce --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# webklar-preview-template + +Vorlage fuer Kunden-Websites mit automatischer Preview unter `*.project.webklar.com`. + +## Preview aktivieren + +Dieses Repo enthaelt [`.webklar-preview.json`](.webklar-preview.json). Beim Push auf den konfigurierten Branch startet der Deploy: + +- URL: `https://project.webklar.com/webhook/gitea` +- Vorschau: `https://.project.webklar.com` + +## Konfiguration (`.webklar-preview.json`) + +| Feld | Beschreibung | +|------|----------------| +| `enabled` | `true` = Preview-Deploy aktiv | +| `type` | `static` (Dateien direkt) oder `node_build` (npm build) | +| `branch` | Branch fuer Deploy, z. B. `main` | +| `displayName` | Anzeigename im Kundenportal | +| `subdomain` | Optional; Default = Repo-Name | + +**Keine Passwoerter** in dieser Datei. + +### Beispiel fuer statische Seite + +```json +{ + "enabled": true, + "type": "static", + "branch": "main", + "displayName": "Friseur Mueller", + "subdomain": "friseur-mueller" +} +``` + +### Beispiel fuer Vite/React (Build) + +```json +{ + "enabled": true, + "type": "node_build", + "branch": "main", + "displayName": "Restaurant Demo", + "subdomain": "restaurant-demo" +} +``` + +## Neues Projekt aus dieser Vorlage + +1. In Gitea: **Use this template** / Repository aus Template erstellen +2. `displayName` und `subdomain` in `.webklar-preview.json` anpassen +3. Website-Inhalt ersetzen (`index.html` oder eigenes Frontend) +4. Push auf `main` – Webhook deployt automatisch +5. Im Admin-Portal (`project.webklar.com`) Kunde dem Projekt zuweisen + +## Gitea-Webhook (einmalig pro Org/Repo) + +- **URL:** `https://project.webklar.com/webhook/gitea` +- **Secret:** `GITEA_WEBHOOK_TOKEN` (Server-`.env`) +- **Events:** Push diff --git a/index.html b/index.html new file mode 100644 index 0000000..7ca53cc --- /dev/null +++ b/index.html @@ -0,0 +1,43 @@ + + + + + + Webklar Preview Vorlage + + + +
+

Webklar Preview Vorlage

+

Dieses Repository ist als Preview-Projekt konfiguriert.

+

Nach dem Push wird die Vorschau unter
+ webklar-preview-template.project.webklar.com
+ bereitgestellt (Login über project.webklar.com).

+

Passe .webklar-preview.json und diese Seite fuer dein Kundenprojekt an.

+
+ +