Communitygithub.com

728188325/frontend-admin-architecture-skill

Codex-Skill zur Erstellung stabiler React/Vue-Frontend-Admin-Architekturprojekte.

Was ist frontend-admin-architecture-skill?

Dieser Skill für AI-Agenten (z. B. Codex) automatisiert die Erstellung oder Normierung von Frontend-Admin-Oberflächen auf Basis von React + TypeScript oder Vue 3 + TypeScript. Er liest frameworkspezifische Referenzdokumente, generiert `docs/architecture.md` und `AGENTS.md` und kann auf Wunsch ein vollständiges Projektgerüst inklusive Ordnerstruktur, Login-Authentifizierung, Layout-Stil und bevorzugtem UI-Theme anlegen. Der Skill führt durch einen mehrstufigen Workflow: Zuerst wird der Projektpfad und das Framework ermittelt (z. B. durch Analyse der `package.json`), dann werden die benötigten Entscheidungen wie UI-Stil, Layout und Authentifizierung abgefragt – entweder interaktiv oder per Default-Konfiguration. Anschließend werden die Architektur- und Governance-Dokumente generiert, das Projektgerüst mit Vite erstellt und die Abhängigkeiten deklariert, ohne sie standardmäßig zu installieren. Der Skill ist besonders nützlich für Teams, die konsistente, qualitätsgesicherte Admin-Projekte schnell bootstrappen oder bestehende Projekte nachträglich standardisieren möchten.

Funktioniert mit~Claude Code✓Codex CLI~Cursor
npx skills add 728188325/frontend-admin-architecture-skill

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

Frontend-Admin-Architektur Skill

Dieser Skill dient der Erstellung oder Normierung von Frontend-Admin-Oberflächen und unterstützt:

  • React + TypeScript
  • Vue 3 + TypeScript

Er wählt das entsprechende Framework-Spezifikum aus, generiert docs/architecture.md und AGENTS.md im Zielprojekt und erstellt auf Wunsch das grundlegende Projektgerüst.

Eingebaute Ressourcen

Lese die entsprechenden Ressourcen basierend auf dem vom Benutzer gewählten Framework. Schreibe keine Inhalte des anderen Frameworks in das Zielprojekt.

React:

  • references/react/architecture.md
  • assets/AGENTS.react.template.md

Vue:

  • references/vue/architecture.md
  • assets/AGENTS.vue.template.md

Allgemeine Projekt-Governance-Dokumente:

  • assets/docs/ai-interaction.md
  • assets/docs/karpathy-guidelines.md
  • assets/docs/ui-style.md
  • assets/docs/ui-quality.md
  • assets/docs/design-tokens.md
  • assets/docs/code-style.md
  • assets/docs/security.md
  • assets/docs/comments.md
  • assets/docs/verification.md
  • assets/docs/git-commit.md
  • assets/docs/knowledge-capture.md

Standard-Workflow

Schritt 1: Umfang festlegen

Wenn der Benutzer keinen Projektpfad angibt, frage zuerst danach.

Wenn der Benutzer das Zielframework nicht genannt hat, überprüfe, ob das Zielverzeichnis bereits ein Projekt enthält:

  • Existiert package.json, lese dependencies und devDependencies.
  • Wenn react oder react-dom vorhanden ist, erkenne als React + TypeScript.
  • Wenn vue oder @vitejs/plugin-vue vorhanden ist, erkenne als Vue 3 + TypeScript.
  • Existiert package.json nicht, suche in vite.config.* nach Hinweisen auf das Framework-Plugin.
  • Wenn sowohl React als auch Vue vorhanden sind oder keine eindeutige Erkennung möglich ist, frage den Benutzer.

Verwende bei Rückfragen:

Bitte wählen Sie das Projekt-Framework:
1. React + TypeScript
2. Vue 3 + TypeScript

Wenn der Benutzer nicht spezifiziert hat, ob nur Dokumente generiert oder auch das Projektgerüst erstellt werden soll, kläre dies mit einer kurzen Rückfrage.

Wenn der Benutzer ein Projekt erstellen oder per Scaffolding anlegen möchte, müssen vor dem Erstellen von Dateien, dem Ausführen von Scaffolding-Befehlen oder der Installation von Abhängigkeiten die folgenden Entscheidungen bestätigt werden. Es sei denn, der Benutzer sagt explizit „Standardeinstellung“, „Standardkonfiguration“, „bitte Standard ohne Nachfragen“ oder eine gleichwertige Formulierung; interpretiere Formulierungen wie „neues Projekt erstellen“, „Projekt anlegen“, „auf dem Desktop neu anlegen“, „weiter“ nicht als Zustimmung zu Standardeinstellungen.

Wenn Angaben zu System-UI-Stil, Layout-Stil, Login-Authentifizierung oder Abhängigkeitsinstallation fehlen, halte an und kläre die fehlenden Optionen mit einer kurzen Frage. Der System-UI-Stil muss zuerst einmal abgefragt werden, aber der Benutzer darf „vorerst nicht festlegen“ wählen; wenn der Benutzer keinen Stil wählt oder selbst definiert, setze keine spezifische visuelle Gestaltung voraus.

  1. Bitte wählen Sie den System-UI-Stil. Der System-UI-Stil beschreibt nur die visuelle Sprache, Informationsdichte und Interaktionsästhetik, nicht den Layout-Stil; wenn der Benutzer vorerst keinen wählt, bleibt docs/ui-style.md ergänzungsfähig:
    • Klassisch und solide: Helle Hintergründe, niedrig gesättigte Primärfarben, klare Tabellen und Formulare, geeignet für allgemeine Unternehmens-Admin-Oberflächen.
    • Minimalistisch und erfrischend: Großzügige Abstände, zurückhaltende Rahmen und Schatten, geeignet für leichte SaaS- und Admin-Bereiche mit geringer Komplexität.
    • Datenintensiv: Kompakte Tabellen, hohe Informationsdichte, geringe Dekoration, geeignet für Operations-, Report-, BI- und Datenmanagement-Admin-Oberflächen.
    • SaaS-Workbench: Stärkerer Arbeitsbereichs-Charakter, mit Übersichten, Schnellzugriffen und Multi-Tenant/Multi-Projekt-Wechsel, geeignet für B2B-Produkte.
    • Tech-Dunkel: Dunkle Hintergründe, hohe Kontraste bei Datenzuständen, moderater Tech-Flair, geeignet für Monitoring, Sicherheit, Betrieb und Dashboard-Systeme.
    • Finanz-Stringent: Zurückhaltende Farbgebung, starke Tabellen, klare Risiko- und Geldbetragsdarstellung, geeignet für Finanz-, Abrechnungs- und Risikocontrolling-Admin-Oberflächen.
    • Behörden-Standard: Blau-Weiß-Palette, klare Hierarchien, standardisierte Formulare und Genehmigungsabläufe, geeignet für Behörden, OA und Genehmigungssysteme.
    • Content-Operations: Fokus auf Medienvorschau, Batch-Operationen, Status-Tags und Review-Workflows, geeignet für CMS, Content- und Marketing-Operations-Admin-Oberflächen.
    • Tool-Effizienz: Betont Schnellzugriffe, mehrspaltige Panels, Tastaturfreundlichkeit und Konfigurationseffizienz, geeignet für toolorientierte oder konfigurationslastige Admin-Oberflächen.
    • Leichtes Portal: Obere Navigation, klare Moduleinstiege, geringe Seitenkomplexität, geeignet für interne Systeme mit wenigen Modulen.
    • Benutzerdefiniert: Der Benutzer beschreibt in natürlicher Sprache den gewünschten visuellen Stil, Referenzprodukte oder Designanforderungen.
    • Vorerst nicht festlegen: Kein spezifischer Stil wird festgehalten; docs/ui-style.md bleibt ergänzungsfähig.
  2. Bitte wählen Sie den Layout-Stil:
    • Klassisches Admin-Layout: linkes Menü + obere Leiste + Inhaltsbereich + Tabs. Geeignet für Admin-Oberflächen mit vielen Menüebenen, traditionelle Admin-UI, als Standard-Layout.
    • Obere Navigation: horizontale Hauptnavigation oben + Inhaltsbereich. Geeignet für leichte Admin-Oberflächen mit wenigen Modulen, flacher Hierarchie und dem Wunsch nach einem offeneren Seitenlayout.
    • Hybride Navigation: obere primäre Geschäftsdomänen + linkes sekundäres Menü + Inhaltsbereich. Geeignet für Admin-Oberflächen mit mehreren Geschäftsdomänen, z. B. Projekte mit Modulen wie Aufträge, Finanzen, System und Inhalt.
    • Schmale Icon-Leiste: links schmale Icon-Leiste + aufklappbares Menü oder sekundäres Panel + Inhaltsbereich. Geeignet für toolorientierte Admin-Oberflächen und moderne SaaS-Anwendungen, die horizontale Breite sparen möchten.
    • Workbench: obere Produktleiste + Organisations-/Projekt-Wechsel + linkes einklappbares Menü + Inhaltsbereich. Geeignet für B2B-Systeme mit häufigen Multi-Tenant-, Multi-Projekt- und Organisationswechseln.
    • Kein Layout vorgeben: Nur grundlegende Routen und Seiten-Container. Geeignet für spätere Festlegung durch Geschäftsanforderungen oder Designvorlagen.
  3. Soll eine grundlegende Login-Authentifizierung enthalten sein? Wenn ja, muss die Login-Seite dem gewählten System-UI-Stil folgen; ist der System-UI-Stil vorerst nicht festgelegt, verwende den neutralen Standardstil der UI-Bibliothek.
  4. Sollen Abhängigkeiten sofort installiert und ein Testlauf durchgeführt werden?
  5. Soll die Standardkonfiguration verwendet werden? (Kein voreingestellter System-UI-Stil + klassisches Admin-Layout + grundlegende Login-Authentifizierung + keine sofortige Abhängigkeitsinstallation.)

Nur wenn der Benutzer explizit die Standardkonfiguration wählt, werden diese Standardwerte verwendet:

  • Paketmanager: pnpm.
  • Login-Authentifizierung: Standardmäßig enthalten: grundlegendes Token-Login-Gerüst.
  • Layout: Standardmäßig enthalten: klassisches Admin-Layout.
  • System-UI-Stil: Standardmäßig nicht voreingestellt; docs/ui-style.md bleibt ergänzungsfähig, wird später durch Geschäftsanforderungen oder Designvorgaben ausgefüllt.
  • Abhängigkeitsinstallation: Standardmäßig werden pnpm install, pnpm add, pnpm dev, pnpm lint, pnpm typecheck, pnpm build nicht ausgeführt; es werden nur Abhängigkeitsdeklarationen, Projektdateien und nachfolgende Befehle geschrieben.
  • React-Stack (Standard): Vite, React, TypeScript, Ant Design, React Router, Axios, TanStack Query, Zustand.
  • Vue-Stack (Standard): Vite, Vue 3, TypeScript, Composition API, <script setup lang="ts">, Vue Router, Pinia, Axios, Element Plus, VueUse.
  • Berechtigungen, Mock, i18n, Diagramme, Monitoring, Deployment, OpenAPI-Codegenerierung: Standardmäßig nicht implementiert; werden bei Bedarf hinzugefügt.

Schritt 2: Entsprechende Spezifikation lesen

Lese vor dem Schreiben von Dateien das entsprechende Architekturdokument basierend auf dem Framework:

  • React: references/react/architecture.md
  • Vue: references/vue/architecture.md

Es dient als Grundlage für:

  • Technologie-Stack
  • Verzeichnisstruktur
  • Modulgrenzen
  • Grenzen gemeinsamer Komponenten
  • API- und Typenablage-Regeln
  • State-Management-Regeln
  • Codierungsrichtlinien
  • Engineering-Qualitätstools
  • Teststrategie

Schritt 3: Projektdokumentation schreiben

Erstelle oder aktualisiere im Zielprojekt:

docs/architecture.md
docs/ai-interaction.md
docs/karpathy-guidelines.md
docs/ui-style.md
docs/ui-quality.md
docs/design-tokens.md
docs/code-style.md
docs/security.md
docs/comments.md
docs/verification.md
docs/git-commit.md
docs/knowledge-capture.md
AGENTS.md

Beim Schreiben von docs/architecture.md beschreibe nur die Architekturregeln, die die nachfolgende Entwicklung des Zielprojekts einhalten muss. Schreibe keine Skill-Workflows, Frage-Formulierungen an den Benutzer oder Entscheidungsprozesse der Initialisierung in das Zielprojekt-Dokument.

Beim Schreiben anderer docs/*.md-Dateien verwende die allgemeinen Governance-Dokumente aus assets/docs/ als Grundlage. Sie beschreiben KI-Interaktion, Karpathy-Richtlinien, UI-Stil-Aufzeichnungen, UI-Qualitäts- und Kreativitätsgrenzen, Design-Tokens, Codestil, Sicherheit und Daten, Kommentare, Validierung, Git-Commits und Wissensdokumentation. Mit Ausnahme von docs/ui-style.md, wo der vom Benutzer explizit gewählte oder benutzerdefinierte System-UI-Stil festgehalten wird, werden keine temporären Entscheidungen des spezifischen Geschäftsprojekts dokumentiert.

Wenn der Benutzer optionale Fähigkeiten wie Login-Authentifizierung oder Layout-Stil wählt oder überspringt, muss das generierte docs/architecture.md mit der tatsächlichen Auswahl übereinstimmen:

  • Gewählte Fähigkeiten: Behalte die entsprechenden Architekturregeln und erwarteten Dateien bei.
  • Übersprungene Fähigkeiten: Behalte nur die Grenzbeschreibung bei; lege klar fest, dass zugehörige Verzeichnisse und Dateien nicht vorab erstellt werden, es sei denn, sie werden durch zukünftige Anforderungen eingeführt.
  • Layout-Stil: Schreibe nur das aktuell gewählte Layout-Verzeichnis, die Komponentenverantwortlichkeiten und die Zustandsgrenzen; schreibe nicht alle Layout-Optionen in das Zielprojekt-Dokument, es sei denn, der Benutzer fordert explizit den Erhalt eines Layout-Vergleichs.

Beim Schreiben von docs/ui-style.md:

  • Der Benutzer wählt einen der zehn integrierten System-UI-Stile aus: Schreibe den Stilnamen, den Anwendungsbereich und die entsprechende Beschreibung.
  • Der Benutzer wählt „benutzerdefiniert“: Fasse die Aussagen des Benutzers zu klaren System-UI-Stil-Anforderungen zusammen; vermeide es, über vom Benutzer nicht bestätigte visuelle Konzepte hinauszugehen.
  • Der Benutzer wählt „vorerst nicht festlegen“ oder gibt keine benutzerdefinierte Beschreibung: Behalte den ergänzungsfähigen Status von assets/docs/ui-style.md bei.
  • Schreibe nicht alle System-UI-Stil-Optionen in das Zielprojekt-Dokument, es sei denn, der Benutzer fordert explizit den Erhalt eines Vergleichs.
  • Wenn eine Login-Seite, ein Layout-Gerüst, eine Startseite/Workbench, eine einfache Listenseite oder Statusseite erstellt wird, müssen diese Oberflächen dem aktuellen System-UI-Stil als visuelle Grundlage folgen; wenn der System-UI-Stil vorerst nicht festgelegt ist, verwende den neutralen Standardstil der entsprechenden UI-Bibliothek, ohne ein zusätzliches visuelles Thema zu erzeugen.

Beim Schreiben von docs/ui-quality.md:

  • Verwende assets/docs/ui-quality.md als Qualitätsuntergrenze für stabile UI-Ausgaben.
  • Stelle klar, dass Kreativität in der visuellen Sprache, Tokens, Login-Seite, Workbench, Leerzuständen, leichten Animationen und der Kombination von Komponenten zum Ausdruck kommen kann; Layout-Gerüst, Tabs, Menüs, Tabellen, Formulare, Paginierung, Modalfenster und der Login-Ablauf müssen stabil und korrekt sein.
  • Beim Erstellen des Projektgerüsts müssen die Login-Seite, das Layout-Gerüst, die Workbench und die grundlegende Listenseite gemäß der Abnahmeliste von docs/ui-quality.md implementiert werden.

Beim Schreiben von AGENTS.md:

  • Verwende für React assets/AGENTS.react.template.md.
  • Verwende für Vue assets/AGENTS.vue.template.md.
  • AGENTS.md dient nur als projektweiter KI-Kollaborations-Einstiegspunkt: Liste die Pflichtlektüre, Prioritäten, wichtige Framework-Grenzen und die Konfliktbehandlung auf; schreibe nicht alle Details in AGENTS.md zurück.
  • Wenn das Zielprojekt bereits eine AGENTS.md hat, überschreibe sie nicht stillschweigend; lese sie zuerst und füge dann vorrangig einen Abschnitt zur Frontend-Admin-Architektur mit Verweis auf docs/architecture.md an.
  • Wenn ein vollständiger Ersatz erforderlich ist, frage zuerst den Benutzer.
  • Wenn das Zielprojekt bereits gleichnamige docs/*.md-Spezifikationen hat, lese zuerst den vorhandenen Inhalt; ergänze nur fehlende Dokumente oder weise den Benutzer auf die Zusammenführungsstrategie hin, es sei denn, der Benutzer fordert explizit eine Überschreibung.

Schritt 4: Projektstruktur erstellen

Erstelle Code-Dateien nur, wenn der Benutzer die Implementierung oder Erstellung eines Projektgerüsts anfordert.

Führe die Erstellungsbefehle basierend auf dem vom Benutzer gewählten Framework aus; führe nicht beide Befehle gleichzeitig aus.

Führe die folgenden Befehle nicht aus, es sei denn, der Benutzer fordert explizit die sofortige Installation von Abhängigkeiten und einen Testlauf an:

pnpm install
pnpm add <package>
pnpm dev
pnpm lint
pnpm typecheck
pnpm build
pnpm test:run

Wenn Abhängigkeiten nicht installiert sind, ändere nur dependencies, devDependencies und scripts in der package.json und teile dem Benutzer nach Abschluss mit, welche Befehle manuell ausgeführt werden müssen.

React:

pnpm create vite <project-name> --template react-ts

Vue:

pnpm create vite <project-name> --template vue-ts

React-Geschäftsmodule verwenden:

src/modules/<business-domain>/<business-module>/
  pages/
  components/
  api/
  hooks/
  types/
  constants/

Vue-Geschäftsmodule verwenden:

src/modules/<business-domain>/<business-module>/
  views/
  components/
  api/
  hooks/
  types/
  constants/

Vue-Projekte verwenden einheitlich hooks/ als Verzeichnisnamen für wiederverwendbare Kompositionslogik, nicht composables/; die Implementierung erfolgt weiterhin mit der Composition API, und die Hook-Dateien exportieren useXxx-Funktionen.

Schritt 5: Nutzungshinweise geben

Nachdem das Dokument oder die Projektstruktur erstellt wurde, teile dem Benutzer mit:

Sie können dies in einer neuen Codex/Agent-Sitzung wie folgt aufrufen:

$frontend-admin-architecture Ich möchte ein neues Vue 3 + TypeScript Enterprise-Admin-System erstellen, bitte initialisieren Sie das Projekt gemäß den Spezifikationen.

Oder:

Verwenden Sie frontend-admin-architecture, um für mein aktuelles React-Projekt die Spezifikationsdokumente in docs/ und die AGENTS.md zu generieren und die Verzeichnisstruktur gemäß den Spezifikationen zu erstellen.

Hinweis gleichzeitig:

  • Neue Teammitglieder sollten den Ordner frontend-admin-architecture in ihr eigenes .agents/skills/-Verzeichnis kopieren.
  • Nach der Installation Codex neu starten oder eine neue Codex-Sitzung öffnen.
  • Für nachfolgende Entwicklungsaufgaben wird empfohlen, so zu beginnen: „Bitte lesen Sie zuerst die AGENTS.md und lesen Sie je nach Aufgabentyp die spezifischen Spezifikationen in docs/, um sich strikt an die Projektspezifikationen zu halten.“

Anleitung zur Projekterstellung

Wenn der Benutzer ein tatsächliches Projekt erstellen möchte:

  1. Erstelle das Projekt mit der entsprechenden Vite-Vorlage.
  2. Schreibe die Abhängigkeitsdeklarationen und Skripte in die package.json oder führe sie zusammen.
  3. Erstelle docs/architecture.md und die allgemeinen Spezifikationsdokumente.
  4. Erstelle oder aktualisiere AGENTS.md.
  5. Erstelle die Verzeichnisstruktur.
  6. Schreibe oder behalte docs/ui-style.md basierend auf dem vom Benutzer gewählten System-UI-Stil und schreibe docs/ui-quality.md als Qualitätsuntergrenze für die UI-Ausgabe.
  7. Stelle zuerst stabile, einsatzbereite Routen, das Layout-Gerüst, Menüs, Tabs, den Login-Ablauf, Listenseiten, Formulare und Zustandsflüsse fertig, bevor du visuelle Verbesserungen vornimmst.
  8. Füge das minimale Anwendungsgerüst basierend auf den vom Benutzer gewählten Layout- und Authentifizierungsoptionen hinzu; wenn eine Login-Seite oder ein Layout-Gerüst erstellt wird, müssen diese dem gewählten System-UI-Stil und der docs/ui-quality.md entsprechen.
  9. Konfiguriere Skripte und Engineering-Tools.
  10. Wenn der Benutzer die sofortige Installation von Abhängigkeiten und Verifikation wählt, führe die Installation, den Start, die Verifikation und die visuelle Browser-Prüfung durch.
  11. Wenn der Benutzer die sofortige Installation von Abhängigkeiten nicht wählt, weise den Benutzer abschließend an, diese selbst auszuführen:
    • pnpm install
    • pnpm dev
    • pnpm lint
    • pnpm typecheck
    • pnpm build

Wenn der Benutzer die sofortige Installation von Abhängigkeiten und Verifikation explizit anfordert, führe aus:

pnpm install
pnpm lint
pnpm typecheck
pnpm build

Wenn das Projekt Tests konfiguriert hat, führe auch aus:

pnpm test:run

Wenn die Umgebung das Starten einer Seite und eine Browser-Prüfung zulässt, öffne außerdem die Login-Seite, die Workbench und die grundlegende Listenseite für eine visuelle Abnahme. Prüfe gezielt:

  • Menü, obere Leiste, Tabs, Breadcrumbs, Inhaltsbereich: keine Überlappungen, Verschiebungen oder schwebende Elemente.
  • Das Theme ist auf Login-Seite, Layout-Gerüst, Tabellen, Formulare, Modalfenster und Status-Tags konsistent.
  • Text läuft bei der primären Desktop-Breite des Projekts nicht über, Buttons werden nicht gequetscht, die Inhaltsbreite ist angemessen; wenn keine Projektvereinbarung existiert, prüfe bevorzugt bei 1440 px und 1920 px.
  • Die Browser-Konsole zeigt keine Laufzeitfehler.

Wenn bestimmte Versionen wichtig sind, frage vor der Installation mit npm view <package> version die aktuelle Version ab. Frontend-Paketversionen ändern sich schnell; verlasse dich nicht langfristig auf alte Versionsnummern.

Begrenzungen

Standardmäßig nicht übermäßig ausbauen.

Füge standardmäßig nicht hinzu, es sei denn, der Benutzer fordert es explizit:

  • RBAC-Implementierung
  • Mock-Server
  • i18n
  • Diagramme
  • Monitoring SDK
  • Docker
  • Nginx
  • CI/CD
  • OpenAPI-Codegenerierung

Behalte die Erweiterungsgrenzen bei, aber halte das initiale Projekt leichtgewichtig.

Verwandte Skills