Hoppa till innehållet
Verifierad

Installera och skapa ett projekt

Skapa ett Xuda CLI-projekt med ett enda kommando och lär dig sedan vad varje genererad fil är till för.

Innan du börjar

CLI-vägen kräver Node.js 18.17.0 eller nyare, vilket är den lägsta motorversion som xuda-cli anger. Inget annat: xuda-cli själv beror på tre paket (express, socket.io, chokidar), och verktyget som skapar ett nytt projekt har inga egna beroenden. Lokal utveckling anropar aldrig en metod som kräver ett betalpaket, så det kostar ingenting att bygga en app på det här sättet.

Skapa en ny app

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

Se vad create-xuda-cli skrev

Skaparen skriver en package.json som redan deklarerar @xuda.io/xuda-framework-plugin-tailwind och @xuda.io/xuda-dbs-plugin-xuda som beroenden och xuda-cli som ett utvecklingsberoende, en xuda.config.js, App.xu, index.html, en components/-mapp och en första node_modules/.project_data/globals.json. Den lägger också en genererad README.md-guide i tolv mappar: de elva typade källmapparna plus en för själva data/, och var och en kan tas bort senare.

Öppna appen

npm run dev skriver ut URL:en den lyssnar på, http://localhost:3000 som standard. index.html serveras som skal och App.xu monteras i #app automatiskt, eftersom den skapade konfigurationen sätter entry: 'index.html' och ingen annan komponent gör anspråk på det elementet. App.xu kompileras alltid till program-id:t app.

Redigera och spara

Redigera App.xu och spara. Bevakaren kompilerar om projektet, återskapar runtime-dokumenten och skickar en omladdning över en socket.io-kanal, så webbläsaren uppdaterar sig själv.

Rensa mappguiderna när du inte behöver dem

bash
npm run clean:readmes

Detta tar bara bort de README-filer som skaparen genererade (spåras med en intern markör). Alla README-filer som du skrivit själv lämnas ifred, och kommandot rapporterar antalet borttagna, överhoppade och saknade var för sig.

Den mentala modellen: tre lager

Om xuda.config.js sätter entry: 'index.html' serveras HTML-skalet först och App.xu monteras i #app om inte något annat redan gjort anspråk på elementet. Om entry utelämnas använder xuda-cli program-id:t app som standard i stället för en HTML-fil.

Rekommenderad uppdelning: behåll index.html som sidskal, behåll App.xu som översta skärm och lägg funktionsskärmar under components/.

Projektets struktur

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-språket för vad som hör hemma i varje mapp och hur mappen som en fil ligger i avgör dess enhetstyp.

xuda.config.js

js
module.exports = {
  entry: 'index.html',
  port: 3000,
  ssr: 'none',
  api_key: '',
  build_id: '',
};
Lämna build_id osatt

Om du sätter build_id blir api_key också obligatorisk, och det pekar mot en fjärrbyggväg som ännu inte har någon implementation bakom sig, så projektet misslyckas med att laddas i stället för att byggas på distans.

Allt annat om kommandon, SSR-lägen och molnsynkronisering finns i CLI-referensen.

Genererade runtime-dokument

xuda-cli kompilerar alltid runtime-dokument till node_modules/.project_data/, en globals.json plus en fil per program. Gamla filer där raderas vid varje kompilering. Behandla det som byggutdata: de .xu- och .json5-filer du skriver är den egentliga källan.

Du kan se en project_data/-mapp eller en .project_data/-mapp i roten i äldre material. De är äldre sökvägar enbart för import, kvar för migrering, och aldrig en plats att skriva till.