Zum Inhalt springen
Geprüft

Installieren und ein Projekt erstellen

Erstelle ein Xuda-CLI-Projekt mit einem Befehl und lerne dann, wofür jede generierte Datei da ist.

Bevor du beginnst

Der CLI-Weg braucht Node.js 18.17.0 oder neuer, die Mindestversion, die xuda-cli angibt. Sonst nichts: xuda-cli selbst hängt von drei Paketen ab (express, socket.io, chokidar), und der Scaffolder, der ein neues Projekt erstellt, hat keine eigenen Abhängigkeiten. Die lokale Entwicklung ruft nie eine tarifgebundene Methode auf, eine App auf diese Weise zu bauen kostet also nichts.

Eine neue App erstellen

bash
npm create xuda-cli@latest my-app
cd my-app
npm install
npm run dev

Sehen, was create-xuda-cli geschrieben hat

Der Scaffolder schreibt eine package.json, die bereits @xuda.io/xuda-framework-plugin-tailwind und @xuda.io/xuda-dbs-plugin-xuda als Abhängigkeiten und xuda-cli als Dev-Abhängigkeit angibt, dazu eine xuda.config.js, App.xu, index.html, einen Ordner components/ und eine erste node_modules/.project_data/globals.json. Außerdem legt er in zwölf Ordnern einen generierten README.md-Leitfaden ab: in den elf typisierten Quellordnern und einem für data/ selbst, jeder später entfernbar.

Die App öffnen

npm run dev gibt die URL aus, auf der es lauscht, standardmäßig http://localhost:3000. index.html wird als Shell ausgeliefert, und App.xu wird automatisch in #app eingehängt, weil die erzeugte Konfiguration entry: 'index.html' setzt und keine andere Komponente dieses Element beansprucht. App.xu kompiliert immer zur Programm-ID app.

Bearbeiten und speichern

Bearbeite App.xu und speichere. Der Watcher kompiliert das Projekt neu, erzeugt die Laufzeitdokumente neu und schiebt über einen socket.io-Kanal ein Neuladen an, der Browser aktualisiert sich also von selbst.

Die Ordner-Leitfäden löschen, sobald du sie nicht mehr brauchst

bash
npm run clean:readmes

Das löscht nur die README-Dateien, die der Scaffolder erzeugt hat (verfolgt über eine interne Markierung). Jede README, die du selbst geschrieben hast, bleibt unberührt, und der Befehl meldet die Zahlen für entfernt, übersprungen und fehlend getrennt.

Das mentale Modell: drei Schichten

Setzt xuda.config.js entry: 'index.html', wird zuerst die HTML-Shell ausgeliefert, und App.xu wird in #app eingehängt, sofern nicht etwas anderes dieses Element schon beansprucht hat. Fehlt entry, nimmt xuda-cli stattdessen standardmäßig die Programm-ID app statt einer HTML-Datei.

Empfohlene Aufteilung: index.html als Seiten-Shell behalten, App.xu als Stammbildschirm behalten und Feature-Bildschirme unter components/ hinzufügen.

Das Projektlayout

my-app/  package.json  xuda.config.js  index.html  App.xu
components/ globals/ data/ get/ set/ batch/ apis/ scripts/ alerts/ tables/ routes/ ai-agents/
node_modules/ .project_data/

Unter Die .xu-Sprache siehst du, was in welchen Ordner gehört und wie der Ordner, in dem eine Datei liegt, ihren Einheitentyp bestimmt.

xuda.config.js

js
module.exports = {
  entry: 'index.html',
  port: 3000,
  ssr: 'none',
  api_key: '',
  build_id: '',
};
build_id ungesetzt lassen

Wird build_id gesetzt, wird auch api_key zur Pflicht, und es zielt auf einen entfernten Build-Pfad, hinter dem noch keine Implementierung steht, das Projekt lädt also nicht, statt entfernt zu bauen.

Alles Weitere zu Befehlen, SSR-Modi und Cloud-Synchronisierung steht in Die CLI-Referenz.

Generierte Laufzeitdokumente

xuda-cli kompiliert Laufzeitdokumente immer nach node_modules/.project_data/, eine globals.json plus eine Datei pro Programm. Veraltete Dateien dort werden bei jeder Kompilierung gelöscht. Behandle es als Build-Ausgabe: Die .xu- und .json5-Dateien, die du schreibst, sind die maßgebliche Quelle.

In älterem Material siehst du eventuell einen Ordner project_data/ oder einen .project_data/ im Stammverzeichnis. Das sind Legacy-Pfade nur für den Import, die der Migration dienen, nie ein Ort zum Schreiben.