Preskočiť na obsah
Overené

Inštalácia a vytvorenie projektu

Vytvorte kostru projektu Xuda CLI jedným príkazom a zistite, na čo slúži každý vygenerovaný súbor.

Skôr než začnete

Cesta cez CLI potrebuje Node.js 18.17.0 alebo novší, čo je minimálna verzia enginu, ktorú xuda-cli deklaruje. Nič iné: samotné xuda-cli závisí od troch balíkov (express, socket.io, chokidar) a nástroj na vytvorenie kostry, ktorý vytvorí nový projekt, nemá žiadne vlastné závislosti. Lokálny vývoj nikdy nevolá metódu viazanú na plán, takže tvorba aplikácie týmto spôsobom nič nestojí.

Vytvorte kostru novej aplikácie

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

Pozrite sa, čo zapísal create-xuda-cli

Nástroj zapíše package.json, ktorý už deklaruje @xuda.io/xuda-framework-plugin-tailwind a @xuda.io/xuda-dbs-plugin-xuda ako závislosti a xuda-cli ako vývojovú závislosť, ďalej xuda.config.js, App.xu, index.html, priečinok components/ a prvý node_modules/.project_data/globals.json. Do dvanástich priečinkov tiež vloží vygenerovaného sprievodcu README.md: jedenásť typovaných zdrojových priečinkov plus jeden pre samotný data/, pričom každý sa dá neskôr odstrániť.

Otvorte aplikáciu

npm run dev vypíše URL, na ktorej počúva, predvolene http://localhost:3000. index.html sa poskytuje ako shell a App.xu sa automaticky pripojí do #app, pretože vygenerovaná konfigurácia nastavuje entry: 'index.html' a žiadny iný komponent si tento element nenárokuje. App.xu sa vždy skompiluje na id programu app.

Upravte a uložte

Upravte App.xu a uložte. Pozorovateľ projekt znova skompiluje, vygeneruje runtime dokumenty a cez kanál socket.io pošle prenačítanie, takže sa prehliadač obnoví sám.

Vyčistite sprievodcov priečinkov, keď ich nepotrebujete

bash
npm run clean:readmes

Tým sa odstránia iba súbory README, ktoré nástroj vygeneroval (sledované vnútornou značkou). Každé README, ktoré ste napísali sami, zostane nedotknuté, a príkaz osobitne hlási počty odstránených, preskočených a chýbajúcich.

Mentálny model: tri vrstvy

Ak xuda.config.js nastavuje entry: 'index.html', najprv sa poskytne HTML shell a App.xu sa pripojí do #app, pokiaľ si tento element už nenárokuje niečo iné. Ak entry chýba, xuda-cli predvolene použije id programu app namiesto súboru HTML.

Odporúčané rozdelenie: ponechajte index.html ako shell stránky, App.xu ako koreňovú obrazovku a obrazovky funkcií pridávajte pod components/.

Rozloženie projektu

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/

Čo patrí do ktorého priečinka a ako priečinok, v ktorom súbor leží, určuje jeho typ jednotky, nájdete v Jazyk .xu.

xuda.config.js

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

Nastavenie build_id zároveň robí api_key povinným a mieri na cestu vzdialeného zostavenia, za ktorou zatiaľ nie je žiadna implementácia, takže sa projekt nenačíta a nezostaví sa vzdialene.

Všetko ostatné o príkazoch, režimoch SSR a cloudovej synchronizácii je v Referencia CLI.

Vygenerované runtime dokumenty

xuda-cli vždy kompiluje runtime dokumenty do node_modules/.project_data/, jeden globals.json a jeden súbor na program. Zastarané súbory tam sa pri každej kompilácii mažú. Berte to ako výstup zostavenia: zdrojom pravdy sú súbory .xu a .json5, ktoré píšete.

V starších materiáloch môžete vidieť priečinok project_data/ alebo koreňový priečinok .project_data/. Sú to staré cesty určené len na import, ponechané kvôli migrácii, nikdy nie miesto na zapisovanie.