Siirry sisältöön
Tarkistettu

Asenna ja luo projekti

Luo Xuda CLI -projektin pohja yhdellä komennolla ja opi, mihin jokaista luotua tiedostoa käytetään.

Ennen kuin aloitat

CLI-polku tarvitsee Node.js-version 18.17.0 tai uudemman, joka on xuda-cli:n ilmoittama moottorin vähimmäisversio. Mitään muuta ei tarvita: xuda-cli itse riippuu kolmesta paketista (express, socket.io, chokidar), ja uuden projektin luova pohjanrakentaja ei riipu mistään. Paikallinen kehitys ei koskaan kutsu pakettirajoitettua metodia, joten sovelluksen rakentaminen näin ei maksa mitään.

Luo uuden sovelluksen pohja

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

Katso, mitä create-xuda-cli kirjoitti

Pohjanrakentaja kirjoittaa package.json-tiedoston, joka jo ilmoittaa riippuvuuksiksi @xuda.io/xuda-framework-plugin-tailwind ja @xuda.io/xuda-dbs-plugin-xuda ja kehitysriippuvuudeksi xuda-cli:n, sekä tiedostot xuda.config.js, App.xu, index.html, components/-kansion ja ensimmäisen node_modules/.project_data/globals.json-tiedoston. Se pudottaa myös generoidun README.md-oppaan kahteentoista kansioon: yksitoista tyypitettyä lähdekansiota sekä yksi data/-kansiolle itselleen, joista jokainen voidaan poistaa myöhemmin.

Avaa sovellus

npm run dev tulostaa URL-osoitteen, jota se kuuntelee, oletuksena http://localhost:3000. index.html tarjoillaan kuoreksi ja App.xu liitetään elementtiin #app automaattisesti, koska pohjan konfiguraatio asettaa entry: 'index.html' eikä mikään muu komponentti vaadi kyseistä elementtiä. App.xu kääntyy aina ohjelmatunnisteeksi app.

Muokkaa ja tallenna

Muokkaa App.xu:ta ja tallenna. Tarkkailija kääntää projektin uudelleen, generoi suoritusaikaiset dokumentit uudelleen ja työntää uudelleenlatauksen socket.io-kanavaa pitkin, joten selain päivittyy itsestään.

Tyhjennä kansio-oppaat, kun et enää tarvitse niitä

bash
npm run clean:readmes

Tämä poistaa vain pohjanrakentajan generoimat README-tiedostot (sisäisellä merkillä seurattuina). Itse kirjoittamasi README-tiedostot jätetään rauhaan, ja komento raportoi poistettujen, ohitettujen ja puuttuvien määrät erikseen.

Mentaalimalli: kolme kerrosta

Jos xuda.config.js asettaa entry: 'index.html', HTML-kuori tarjoillaan ensin ja App.xu liitetään elementtiin #app, ellei jokin muu ole jo vaatinut sitä. Jos entry jätetään pois, xuda-cli käyttää oletuksena ohjelmatunnistetta app HTML-tiedoston sijaan.

Suositeltu jako: pidä index.html sivukuorena, pidä App.xu juurinäkymänä ja lisää toiminnalliset näkymät kansioon components/.

Projektin rakenne

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/

Katso .xu-kieli, mitä kuhunkin kansioon kuuluu ja miten kansio, jossa tiedosto sijaitsee, määrää sen yksikkötyypin.

xuda.config.js

js
module.exports = {
  entry: 'index.html',
  port: 3000,
  ssr: 'none',
  api_key: '',
  build_id: '',
};
Jätä build_id asettamatta

build_id:n asettaminen tekee myös api_key:stä pakollisen, ja se kohdistuu etäkoontipolkuun, jolla ei vielä ole toteutusta, joten projektin lataus epäonnistuu sen sijaan, että koonti tehtäisiin etänä.

Kaikki muu komennoista, SSR-tiloista ja pilvisynkronoinnista on sivulla CLI-viite.

Generoidut suoritusaikaiset dokumentit

xuda-cli kääntää suoritusaikaiset dokumentit aina kansioon node_modules/.project_data/: yksi globals.json ja yksi tiedosto jokaista ohjelmaa kohden. Vanhentuneet tiedostot siellä poistetaan joka käännöksellä. Käsittele sitä koontitulosteena: itse kirjoittamasi .xu- ja .json5-tiedostot ovat totuuden lähde.

Vanhemmassa materiaalissa saatat nähdä project_data/-kansion tai juuren .project_data/-kansion. Ne ovat vanhoja vain tuontiin tarkoitettuja polkuja, jotka on säilytetty migraatiota varten, eikä niihin koskaan kirjoiteta.