feat: Replace web project skeleton with AI briefing and framework documentation, and remove various development-related files.
This commit is contained in:
1elle1
169
README.md
169
README.md
@@ -1,146 +1,73 @@
|
||||
# Website Skeleton
|
||||
# WebsiteSkeleton
|
||||
|
||||
Minimalistisches Runtime-Skeleton für KI-generierte Websites.
|
||||
## AI-First Website Generation System
|
||||
|
||||
Dieses Repository ist ein **Skeleton für die KI-gestützte Website-Generierung**. Es enthält keine lauffähige Website, sondern ausschließlich Markdown-Dateien, die der KI beschreiben, **was** erreicht werden soll.
|
||||
|
||||
Die KI entscheidet autonom über:
|
||||
- Seitenarchitektur & Struktur
|
||||
- Layout & Section-Reihenfolge
|
||||
- Typografie & Spacing
|
||||
- Komponentenwahl
|
||||
- Visuelle Hierarchie
|
||||
|
||||
---
|
||||
|
||||
## Was ist das?
|
||||
|
||||
Dieses Repository ist **kein Website-Template**. Es enthält:
|
||||
|
||||
- Keine fertigen Layouts
|
||||
- Keine UI-Komponenten
|
||||
- Keine Design-Vorgaben
|
||||
|
||||
Es ist ein neutraler, stabiler Arbeitscontainer, mit dem KI individuelle Websites von Grund auf generiert.
|
||||
|
||||
---
|
||||
|
||||
## Für KI-Systeme
|
||||
|
||||
**Vor der Website-Generierung müssen folgende Dateien gelesen werden:**
|
||||
|
||||
1. `/skills/SYSTEM_SKILLS.md` - Grundregeln und Verbote
|
||||
2. `/skills/UI_GUIDELINES.md` - Qualitätsstandards
|
||||
3. `/skills/DEFINITION_OF_DONE.md` - Abnahmekriterien
|
||||
4. `/spec/ProjectSpec.json` - Projektspezifikation
|
||||
5. `/spec/design_tokens.json` - Design-System
|
||||
6. `/prompts/master_prompt.md` - Workflow-Anleitung
|
||||
|
||||
---
|
||||
|
||||
## Tech-Stack
|
||||
|
||||
| Kategorie | Technologie |
|
||||
|-----------|-------------|
|
||||
| Framework | Next.js 15+ (App Router) |
|
||||
| UI | React 19 |
|
||||
| Sprache | TypeScript |
|
||||
| Styling | Tailwind CSS v4 |
|
||||
| Animation | framer-motion, lenis |
|
||||
| Icons | lucide-react |
|
||||
| Runtime | Node.js 20.x LTS |
|
||||
|
||||
---
|
||||
|
||||
## Projektstruktur
|
||||
## Repository-Struktur
|
||||
|
||||
```
|
||||
/
|
||||
├── app/ # Next.js App Router
|
||||
├── components/ # Fundament-Komponenten
|
||||
│ ├── layout/ # Container, Section
|
||||
│ └── ui/ # Button, Card
|
||||
├── src/ # Projekt-spezifischer Code (Utils, Hooks)
|
||||
├── skills/ # KI-Regeln und Guidelines
|
||||
├── spec/ # Projektspezifikation & Design Tokens
|
||||
├── theme/ # CSS Variables & Stylesheets
|
||||
├── prompts/ # KI-Prompts
|
||||
├── content/ # Inhalte (MDX, JSON)
|
||||
├── assets/ # Medien (Bilder, Fonts)
|
||||
├── meta/ # Generierungs-Logs
|
||||
├── docker/ # Docker-Konfiguration
|
||||
└── [config files] # package.json, tsconfig.json, etc.
|
||||
/framework
|
||||
FRAMEWORK.md # Technischer Stack (Next.js, TypeScript, Tailwind)
|
||||
|
||||
/ai
|
||||
SYSTEM_RULES.md # Harte Qualitätsregeln
|
||||
QUALITY_STANDARD.md # Definition von "launch-ready"
|
||||
AI_DECISION_LOGIC.md # Entscheidungskompetenz der KI
|
||||
|
||||
/briefs
|
||||
PROJECT_BRIEF.md # Projektübersicht
|
||||
BUSINESS_CONTEXT.md # Firma, Markt, Positionierung
|
||||
USER_CONTEXT.md # Zielgruppe, Bedürfnisse
|
||||
CONTENT_INTENT.md # Inhalte, die überzeugen sollen
|
||||
DESIGN_INTENT.md # Gewünschte Wirkung
|
||||
SEO_INTENT.md # Keywords, Suchintention
|
||||
CONSTRAINTS.md # No-Gos, rechtliche Anforderungen
|
||||
|
||||
/prompts
|
||||
MASTER_PROMPT.md # Orchestrator-Prompt für die KI
|
||||
|
||||
README.md # Diese Datei
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Entwicklung
|
||||
## Verwendung
|
||||
|
||||
### Voraussetzungen
|
||||
### Für den Website Prototype Generator:
|
||||
|
||||
- Node.js 20.x oder höher
|
||||
- npm
|
||||
1. Clone dieses Repository
|
||||
2. Befülle die `briefs/*.md` Dateien mit Kundeninformationen
|
||||
3. Übergib das Repository an die KI zusammen mit `prompts/MASTER_PROMPT.md`
|
||||
4. Die KI generiert eine vollständige, launch-ready Website
|
||||
|
||||
### Installation
|
||||
### Wichtig:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### Development Server
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Öffne [http://localhost:3000](http://localhost:3000).
|
||||
|
||||
### Production Build
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
npm run start
|
||||
```
|
||||
- Die Dateien in `/ai` und `/framework` bleiben **unverändert**
|
||||
- Nur die Dateien in `/briefs` werden pro Projekt angepasst
|
||||
- Der `MASTER_PROMPT.md` orchestriert den gesamten Generierungsprozess
|
||||
|
||||
---
|
||||
|
||||
## Docker
|
||||
## Philosophie
|
||||
|
||||
### Development
|
||||
> Das Skeleton beschreibt **WAS**, nicht **WIE**.
|
||||
|
||||
```bash
|
||||
cd docker
|
||||
docker-compose up
|
||||
```
|
||||
Klassische Templates kontrollieren die KI durch vordefinierte Strukturen. Dieses System **befähigt** die KI, optimale Entscheidungen zu treffen.
|
||||
|
||||
### Production Build
|
||||
|
||||
```bash
|
||||
docker build -f docker/Dockerfile -t website .
|
||||
docker run -p 3000:3000 website
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Workflow für neue Projekte
|
||||
|
||||
1. **Spec ausfüllen**: `spec/ProjectSpec.json` mit Projektdaten füllen
|
||||
2. **Tokens anpassen**: `spec/design_tokens.json` mit Farben, Fonts etc.
|
||||
3. **KI starten**: Mit Verweis auf `/skills` und `/spec`
|
||||
4. **Generieren**: KI erstellt Website basierend auf Specs
|
||||
5. **Prüfen**: Definition of Done validieren
|
||||
6. **Deployen**: Build erstellen und ausliefern
|
||||
|
||||
---
|
||||
|
||||
## Entwicklungshinweise
|
||||
|
||||
> **Build und Dev dürfen nicht gleichzeitig laufen.**
|
||||
> Next.js kann CSS-Referenzen verlieren, wenn `npm run build` und `npm run dev` parallel ausgeführt werden.
|
||||
> Nutze `npm run clean` um den `.next` Cache zu löschen, falls Styling-Probleme auftreten.
|
||||
|
||||
---
|
||||
|
||||
## Wichtig
|
||||
|
||||
- Dieses Skeleton erzwingt **kein Design**
|
||||
- Alle Werte in `design_tokens.json` sind **Platzhalter**
|
||||
- Die KI **muss** die Skills lesen bevor sie Code generiert
|
||||
- Jede Website wird **individuell** erstellt
|
||||
Das Ergebnis: Jeder Kunde erhält eine **einzigartige**, auf seinen Kontext zugeschnittene Website – keine "gleich gebauten" Varianten desselben Templates.
|
||||
|
||||
---
|
||||
|
||||
## Lizenz
|
||||
|
||||
Proprietär - Nur für autorisierte Nutzung.
|
||||
Copyright © EB Solutions
|
||||
|
||||
Reference in New Issue
Block a user