Přeskočit na obsah
Ověřeno

Instalace a vytvoření projektu

Vytvořte projekt Xuda CLI jedním příkazem a zjistěte, k čemu slouží každý vygenerovaný soubor.

Než začnete

Cesta přes CLI vyžaduje Node.js 18.17.0 nebo novější, což je minimální verze, kterou xuda-cli deklaruje. Nic dalšího: samotné xuda-cli závisí na třech balíčcích (express, socket.io, chokidar) a nástroj, který nový projekt vytváří, nemá žádné vlastní závislosti. Lokální vývoj nikdy nevolá metodu omezenou tarifem, takže vytváření aplikace tímto způsobem nic nestojí.

Vytvořte novou aplikaci

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

Podívejte se, co create-xuda-cli zapsal

Nástroj zapíše package.json, který už deklaruje @xuda.io/xuda-framework-plugin-tailwind a @xuda.io/xuda-dbs-plugin-xuda jako závislosti a xuda-cli jako vývojovou závislost, dále xuda.config.js, App.xu, index.html, složku components/ a první node_modules/.project_data/globals.json. Do dvanácti složek také vloží vygenerovaného průvodce README.md: jedenáct typovaných zdrojových složek plus jednu pro samotné data/, každého z nich lze později odebrat.

Otevřete aplikaci

npm run dev vypíše adresu URL, na které naslouchá, ve výchozím stavu http://localhost:3000. index.html se servíruje jako obal a App.xu se automaticky připojí do #app, protože vygenerovaná konfigurace nastavuje entry: 'index.html' a žádná jiná komponenta si tento element nenárokuje. App.xu se vždy kompiluje na id programu app.

Upravte a uložte

Upravte App.xu a uložte. Sledovač projekt znovu zkompiluje, přegeneruje runtime dokumenty a pošle znovunačtení přes kanál socket.io, takže se prohlížeč obnoví sám.

Průvodce složkami smažte, až je nebudete potřebovat

bash
npm run clean:readmes

Smaže jen soubory README, které nástroj vygeneroval (sledované interní značkou). Každé README, které jste napsali sami, zůstane nedotčené, a příkaz oddělně hlásí počty odstraněných, přeskočených a chybějících souborů.

Mentální model: tři vrstvy

Pokud xuda.config.js nastavuje entry: 'index.html', nejdřív se servíruje obal HTML a App.xu se připojí do #app, pokud si tento element už nenárokuje něco jiného. Pokud je entry vynecháno, xuda-cli místo souboru HTML použije výchozí id programu app.

Doporučené rozdělení: ponechte index.html jako obal stránky, App.xu jako kořenovou obrazovku a funkční obrazovky přidávejte pod components/.

Rozložení 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/

Co patří do které složky a jak složka, ve které soubor leží, určuje jeho typ jednotky, viz Jazyk .xu.

xuda.config.js

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

Nastavení build_id také činí api_key povinným a míří na cestu vzdáleného sestavení, za kterou zatím žádná implementace nestojí, takže se projekt místo vzdáleného sestavení nenačte.

Vše ostatní o příkazech, režimech SSR a cloudové synchronizaci najdete v Reference CLI.

Vygenerované runtime dokumenty

xuda-cli vždy kompiluje runtime dokumenty do node_modules/.project_data/, jeden globals.json a jeden soubor na program. Zastaralé soubory tam se při každé kompilaci smažou. Berte to jako výstup sestavení: zdrojem pravdy jsou soubory .xu a .json5, které píšete.

Ve starších materiálech můžete narazit na složku project_data/ nebo kořenovou složku .project_data/. Jsou to starší cesty určené jen pro import, ponechané kvůli migraci, nikdy ne místo, kam zapisovat.