Naar de inhoud springen
Geverifieerd

Installeren en een project aanmaken

Zet een Xuda CLI-project op met één commando en leer waarvoor elk gegenereerd bestand dient.

Voordat je begint

Voor de CLI-route heb je Node.js 18.17.0 of nieuwer nodig, de ondergrens die xuda-cli opgeeft. Meer is niet nodig: xuda-cli zelf hangt af van drie pakketten (express, socket.io, chokidar), en de scaffolder die een nieuw project aanmaakt heeft geen eigen afhankelijkheden. Lokale ontwikkeling roept nooit een methode aan die aan een abonnement gebonden is, dus een app op deze manier bouwen kost niets.

Zet een nieuwe app op

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

Bekijk wat create-xuda-cli heeft geschreven

De scaffolder schrijft een package.json waarin @xuda.io/xuda-framework-plugin-tailwind en @xuda.io/xuda-dbs-plugin-xuda al als dependencies staan en xuda-cli als dev dependency, een xuda.config.js, App.xu, index.html, een map components/ en een eerste node_modules/.project_data/globals.json. Ook zet hij een gegenereerde README.md-gids in twaalf mappen: de elf getypeerde bronmappen plus één voor data/ zelf, elk later te verwijderen.

Open de app

npm run dev toont de URL waarop hij luistert, standaard http://localhost:3000. index.html wordt als shell geserveerd en App.xu mount automatisch in #app, omdat de config van de scaffolder entry: 'index.html' instelt en geen andere component dat element claimt. App.xu compileert altijd naar de programma-id app.

Bewerk en sla op

Bewerk App.xu en sla op. De watcher compileert het project opnieuw, genereert de runtimedocumenten opnieuw en stuurt een reload over een socket.io-kanaal, zodat de browser zichzelf ververst.

Ruim de maphandleidingen op als je ze niet meer nodig hebt

bash
npm run clean:readmes

Dit verwijdert alleen de README-bestanden die de scaffolder heeft gegenereerd (bijgehouden via een interne markering). Een README die je zelf hebt geschreven blijft met rust gelaten, en het commando meldt het aantal verwijderde, overgeslagen en ontbrekende bestanden apart.

Het denkmodel: drie lagen

Als xuda.config.js entry: 'index.html' instelt, wordt eerst de HTML-shell geserveerd en mount App.xu in #app, tenzij iets anders dat element al heeft geclaimd. Is entry weggelaten, dan gebruikt xuda-cli standaard de programma-id app in plaats van een HTML-bestand.

Aanbevolen indeling: houd index.html als paginashell, houd App.xu als hoofdscherm en voeg featureschermen toe onder components/.

De projectindeling

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/

Zie De .xu-taal voor wat in elke map thuishoort en hoe de map waarin een bestand staat het eenheidstype bepaalt.

xuda.config.js

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

Als je build_id instelt, wordt api_key ook verplicht, en het wijst naar een remote buildpad waar nog geen implementatie achter zit, dus het project laadt niet in plaats van remote te bouwen.

Alles over commando's, SSR-modi en cloudsynchronisatie staat in De CLI-referentie.

Gegenereerde runtimedocs

xuda-cli compileert runtimedocs altijd naar node_modules/.project_data/: één globals.json plus één bestand per programma. Verouderde bestanden daar worden bij elke compilatie verwijderd. Zie het als buildoutput: de .xu- en .json5-bestanden die je schrijft zijn de bron van waarheid.

In oudere materialen kom je misschien een map project_data/ of een .project_data/ in de root tegen. Dat zijn verouderde paden die alleen voor import bestaan, voor migratie, en nooit een plek om naar te schrijven.