De CLI-referentie
Elk xuda-cli-commando, elk xuda.config.js-veld en wat cloudsynchronisatie nu kan.
xuda-cli bestaat uit drie commando's, plus help. Geen ervan neemt een flag: elk extra argument is
een harde fout, en elke instelling staat in xuda.config.js.
Commando's
dev draait de app helemaal zonder cloudverbinding: hij beantwoordt zelf een handvol lokale
endpoints zodat de app alles heeft wat hij nodig heeft, en in die geïsoleerde modus handelt hij ook
de vier lees- en schrijfbewerkingen op tabellen lokaal af. Al het andere wordt upstream doorgestuurd
als er een API-sleutel is ingesteld, en geweigerd met een duidelijke melding als dat niet zo is.
xuda.config.js
Server-side rendering
Zet ssr op first_page om het entry-programma server-side te renderen en vanaf daar over te
dragen aan de client, of op full om de app server-side te renderen en client-side te hydrateren.
Laat het op none staan om volledig in de browser te renderen.
Stel de modus in
Bewerk ssr in xuda.config.js.
Herstart dev
npm run dev moet na een SSR-wijziging opnieuw worden gestart.
Controleer de payload
De CLI rendert het entry-programma tot een string in een sandbox-context, injecteert de markup in de shell en geeft de client een renderpayload om mee verder te gaan.
API-sleutels
Open in het dashboard Ontwikkelaars, dan het tabblad API-sleutels, en druk op Key aanmaken. Geef de sleutel een naam, beperk eventueel de Toegestane domeinen en kies een toegangsmodus.
Een sleutel met de juiste toegang kan de appdatamethoden nu direct via HTTP aanroepen: dbs_read,
dbs_create, dbs_update en dbs_delete. Zie JavaScript
Framework voor de vorm van het request.
Cloudsynchronisatie
Het doel van sync is de documenten van een cloudproject naar lokale bronbestanden te halen en
lokale wijzigingen terug te pushen. Het voert eerst een voorwaardencontrole uit die bevestigt dat
vier platformmethoden aanroepbaar zijn voordat het iets anders doet:
get_app_system_api_methods, get_app_api_keys, get_project_docs,
update_app_info_doc_to_db_couch.
Twee daarvan zijn dashboardsessiemethoden die per ontwerp nooit voorkomen in de cataloguslijst die
de controle leest, en de andere twee zijn helemaal niet geregistreerd als aanroepbare
platformmethoden, dus de controle slaagt niet met de huidige methodencatalogus. Daarnaast laadt alles
in de CLI wat api_key nodig heeft, inclusief upstream-doorsturen en sync zelf, platformmodules
van schijf die een gepubliceerde npm-installatie van de CLI niet meelevert.
Zie dev als de lokale toolchain en gebruik Studio om projectwerk in het cloudproject te krijgen.
Dit alles raakt lokale ontwikkeling niet: dev, live reload, SSR en plugins werken allemaal zonder
cloudverbinding.
Als sync zijn volledige reeks wel uitvoert, doet het dit: het controleert of de app de vereiste
CPI-methoden aanbiedt, controleert of de huidige API-sleutel ze mag gebruiken, downloadt remote
docs naar node_modules/.project_data/, maakt ontbrekende lokale bronbestanden aan uit die docs
(bestaande lokale bestanden worden nooit overschreven), compileert lokale bron opnieuw naar
node_modules/.project_data/ en uploadt gewijzigde docs terug naar de cloud.
Problemen oplossen
Abonnementen en limieten
Het framework zelf is gratis: lokale ontwikkeling met beide schrijfroutes roept nooit een methode aan die aan een abonnement gebonden is, de CLI-pakketten zijn openbaar gepubliceerd op npm en API-sleutels zijn gratis, ongeacht de toegangsmodus. Wat een accountabonnement oplevert is deployen, wat niet beschikbaar is in het Gratis abonnement en beschikbaar is vanaf Pro.