Vai al contenuto
Verificata

Installare e creare un progetto

Crea lo scheletro di un progetto Xuda CLI con un solo comando, poi scopri a che cosa serve ogni file generato.

Prima di iniziare

Il percorso CLI richiede Node.js 18.17.0 o successivo, che è la versione minima dichiarata da xuda-cli. Nient'altro: xuda-cli stesso dipende da tre pacchetti (express, socket.io, chokidar), e lo scaffolder che crea un nuovo progetto non ha dipendenze proprie. Lo sviluppo in locale non chiama mai un metodo vincolato a un piano, quindi creare un'app in questo modo non costa nulla.

Crea lo scheletro di una nuova app

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

Guarda che cosa ha scritto create-xuda-cli

Lo scaffolder scrive un package.json che dichiara già @xuda.io/xuda-framework-plugin-tailwind e @xuda.io/xuda-dbs-plugin-xuda come dipendenze e xuda-cli come dipendenza di sviluppo, un xuda.config.js, App.xu, index.html, una cartella components/ e un primo node_modules/.project_data/globals.json. Inserisce inoltre una guida README.md generata in dodici cartelle: le undici cartelle di sorgenti tipizzate più una per data/ stessa, ciascuna rimovibile in seguito.

Apri l'app

npm run dev stampa l'URL su cui è in ascolto, http://localhost:3000 per impostazione predefinita. index.html viene servito come shell e App.xu si monta automaticamente in #app, perché la configurazione generata imposta entry: 'index.html' e nessun altro componente rivendica quell'elemento. App.xu si compila sempre nell'id di programma app.

Modifica e salva

Modifica App.xu e salva. Il watcher ricompila il progetto, rigenera i documenti di runtime e invia un ricaricamento tramite un canale socket.io, quindi il browser si aggiorna da solo.

Elimina le guide delle cartelle quando non ti servono più

bash
npm run clean:readmes

Questo elimina solo i file README generati dallo scaffolder (tracciati da un marcatore interno). Qualsiasi README che hai scritto tu viene lasciato com'è, e il comando riporta separatamente il numero di file rimossi, saltati e mancanti.

Il modello mentale: tre livelli

Se xuda.config.js imposta entry: 'index.html', la shell HTML viene servita per prima e App.xu si monta in #app a meno che qualcos'altro abbia già rivendicato quell'elemento. Se entry è omesso, xuda-cli usa invece per impostazione predefinita l'id di programma app anziché un file HTML.

Suddivisione consigliata: tieni index.html come shell della pagina, tieni App.xu come schermata radice e aggiungi le schermate delle funzionalità sotto components/.

La struttura del progetto

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/

Vedi Il linguaggio .xu per sapere che cosa va in ogni cartella e come la cartella in cui si trova un file ne decide il tipo di unità.

xuda.config.js

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

Impostare build_id rende obbligatorio anche api_key, e punta a un percorso di build remota dietro cui non c'è ancora alcuna implementazione, quindi il progetto non riuscirà a caricarsi invece di essere creato in remoto.

Tutto il resto su comandi, modalità SSR e sincronizzazione cloud si trova in Riferimento della CLI.

Documenti di runtime generati

xuda-cli compila sempre i documenti di runtime in node_modules/.project_data/, un globals.json più un file per programma. I file obsoleti lì vengono eliminati a ogni compilazione. Consideralo output di build: i file .xu e .json5 che scrivi tu sono la fonte di verità.

Nel materiale più vecchio puoi trovare una cartella project_data/ o una cartella .project_data/ nella radice. Sono percorsi legacy solo per l'importazione, mantenuti per la migrazione, e mai un posto in cui scrivere.