Gå til indhold
Bekræftet

Installer og opret et projekt

Opret et Xuda CLI-projekt med én kommando, og lær så, hvad hver genereret fil bruges til.

Før du starter

CLI-vejen kræver Node.js 18.17.0 eller nyere, som er den motorgrænse, xuda-cli erklærer. Intet andet: xuda-cli selv afhænger af tre pakker (express, socket.io, chokidar), og scaffolderen, der opretter et nyt projekt, har ingen afhængigheder selv. Lokal udvikling kalder aldrig en metode, der er bundet til en plan, så det koster ikke noget at bygge en app på denne måde.

Opret en ny app

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

Se, hvad create-xuda-cli skrev

Scaffolderen skriver en package.json, der allerede erklærer @xuda.io/xuda-framework-plugin-tailwind og @xuda.io/xuda-dbs-plugin-xuda som afhængigheder og xuda-cli som udviklingsafhængighed, en xuda.config.js, App.xu, index.html, en components/-mappe og en første node_modules/.project_data/globals.json. Den lægger også en genereret README.md-vejledning i tolv mapper: de elleve typede kildemapper plus én til selve data/, og hver af dem kan fjernes senere.

Åbn appen

npm run dev udskriver den URL, den lytter på, som standard http://localhost:3000. index.html serveres som skallen, og App.xu monteres automatisk i #app, fordi den oprettede konfiguration sætter entry: 'index.html', og ingen anden komponent gør krav på det element. App.xu kompileres altid til program-id'et app.

Rediger og gem

Rediger App.xu og gem. Overvågeren kompilerer projektet igen, genererer runtime-dokumenterne på ny og sender en reload over en socket.io-kanal, så browseren opdaterer sig selv.

Ryd mappevejledningerne, når du ikke har brug for dem

bash
npm run clean:readmes

Det sletter kun de README-filer, scaffolderen genererede (de spores med en intern markør). Enhver README, du selv har skrevet, bliver ladt i fred, og kommandoen rapporterer fjernede, sprunget over og manglende separat.

Den mentale model: tre lag

Hvis xuda.config.js sætter entry: 'index.html', serveres HTML-skallen først, og App.xu monteres i #app, medmindre noget andet allerede har taget det element. Hvis entry udelades, bruger xuda-cli som standard program-id'et app i stedet for en HTML-fil.

Anbefalet opdeling: behold index.html som sideskal, behold App.xu som yderste skærm, og tilføj funktionsskærme under components/.

Projektets opbygning

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/

Se .xu-sproget for, hvad der hører hjemme i hver mappe, og hvordan den mappe, en fil ligger i, afgør dens enhedstype.

xuda.config.js

js
module.exports = {
  entry: 'index.html',
  port: 3000,
  ssr: 'none',
  api_key: '',
  build_id: '',
};
Lad build_id stå usat

Når du sætter build_id, bliver api_key også obligatorisk, og den peger på en ekstern build-sti, der endnu ikke har nogen implementering bag sig, så projektet fejler ved indlæsning i stedet for at bygge eksternt.

Alt andet om kommandoer, SSR-tilstande og cloud-synkronisering findes i CLI-referencen.

Genererede runtime-dokumenter

xuda-cli kompilerer altid runtime-dokumenter ind i node_modules/.project_data/, én globals.json plus én fil pr. program. Forældede filer slettes ved hver kompilering. Behandl den som build-output: de .xu- og .json5-filer, du skriver, er sandheden.

Du kan se en project_data/-mappe eller en .project_data/-mappe i roden i ældre materiale. Det er ældre stier, der kun bruges til import ved migrering, og aldrig et sted at skrive.