Przejdź do treści
Zweryfikowano

Instalacja i tworzenie projektu

Wygeneruj projekt Xuda CLI jednym poleceniem, a potem dowiedz się, do czego służy każdy wygenerowany plik.

Zanim zaczniesz

Ścieżka CLI wymaga Node.js w wersji 18.17.0 lub nowszej, bo taki minimalny silnik deklaruje xuda-cli. Nic więcej: sam xuda-cli zależy od trzech pakietów (express, socket.io, chokidar), a generator tworzący nowy projekt nie ma własnych zależności. Lokalne programowanie nigdy nie wywołuje metody ograniczonej planem, więc budowanie aplikacji tą drogą nic nie kosztuje.

Wygeneruj nową aplikację

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

Zobacz, co zapisał create-xuda-cli

Generator zapisuje package.json, który już deklaruje @xuda.io/xuda-framework-plugin-tailwind i @xuda.io/xuda-dbs-plugin-xuda jako zależności, a xuda-cli jako zależność deweloperską, a także xuda.config.js, App.xu, index.html, folder components/ i pierwszy plik node_modules/.project_data/globals.json. Do dwunastu folderów dodaje też wygenerowany przewodnik README.md: jedenaście typowanych folderów źródłowych plus jeden dla samego data/. Każdy z nich możesz później usunąć.

Otwórz aplikację

npm run dev wypisuje adres, na którym nasłuchuje, domyślnie http://localhost:3000. index.html jest serwowany jako powłoka, a App.xu montuje się automatycznie w #app, ponieważ wygenerowana konfiguracja ustawia entry: 'index.html', a żaden inny komponent nie zajmuje tego elementu. App.xu zawsze kompiluje się do identyfikatora programu app.

Edytuj i zapisz

Edytuj App.xu i zapisz. Obserwator kompiluje projekt ponownie, odtwarza dokumenty uruchomieniowe i wysyła przeładowanie kanałem socket.io, więc przeglądarka odświeża się sama.

Wyczyść przewodniki po folderach, gdy już ich nie potrzebujesz

bash
npm run clean:readmes

To usuwa tylko pliki README wygenerowane przez generator (śledzone wewnętrznym znacznikiem). Każdy README napisany przez Ciebie zostaje nietknięty, a polecenie raportuje osobno liczby usuniętych, pominiętych i brakujących plików.

Model myślowy: trzy warstwy

Jeśli xuda.config.js ustawia entry: 'index.html', najpierw serwowana jest powłoka HTML, a App.xu montuje się w #app, chyba że ten element zajął już ktoś inny. Jeśli entry pominiesz, xuda-cli domyślnie użyje identyfikatora programu app zamiast pliku HTML.

Zalecany podział: index.html zostaje powłoką strony, App.xu głównym ekranem, a ekrany funkcji dodajesz w components/.

Układ 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/

Zobacz Język .xu, co należy do którego folderu i jak folder, w którym leży plik, decyduje o jego typie jednostki.

xuda.config.js

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

Ustawienie build_id sprawia też, że api_key jest obowiązkowy, i wskazuje zdalną ścieżkę budowania, za którą nie stoi jeszcze żadna implementacja, więc projekt się nie załaduje zamiast budować zdalnie.

Wszystko inne o poleceniach, trybach SSR i synchronizacji z chmurą znajdziesz w Dokumentacji CLI.

Wygenerowane dokumenty uruchomieniowe

xuda-cli zawsze kompiluje dokumenty uruchomieniowe do node_modules/.project_data/: jeden globals.json i po jednym pliku na program. Nieaktualne pliki są tam usuwane przy każdej kompilacji. Traktuj to jako wynik budowania: źródłem prawdy są pliki .xu i .json5, które piszesz.

W starszych materiałach możesz zobaczyć folder project_data/ lub główny folder .project_data/. To starsze ścieżki tylko do importu, zachowane na potrzeby migracji, i nigdy nie są miejscem do zapisu.