Aller au contenu
Vérifié

Installer et créer un projet

Créez un projet Xuda CLI en une seule commande, puis découvrez à quoi sert chaque fichier généré.

Avant de commencer

La voie CLI nécessite Node.js 18.17.0 ou plus récent, qui est le plancher de moteur déclaré par xuda-cli. Rien d'autre : xuda-cli dépend lui-même de trois paquets (express, socket.io, chokidar), et l'outil de création d'un nouveau projet n'a aucune dépendance propre. Le développement local n'appelle jamais de méthode soumise à un forfait, donc créer une app de cette façon ne coûte rien.

Créez une nouvelle app

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

Voyez ce que create-xuda-cli a écrit

L'outil de création écrit un package.json qui déclare déjà @xuda.io/xuda-framework-plugin-tailwind et @xuda.io/xuda-dbs-plugin-xuda comme dépendances et xuda-cli comme dépendance de développement, un xuda.config.js, App.xu, index.html, un dossier components/ et un premier node_modules/.project_data/globals.json. Il dépose aussi un guide README.md généré dans douze dossiers : les onze dossiers sources typés plus un pour data/ lui-même, chacun pouvant être supprimé plus tard.

Ouvrez l'app

npm run dev affiche l'URL sur laquelle il écoute, http://localhost:3000 par défaut. index.html est servi comme coque et App.xu se monte automatiquement dans #app, parce que la configuration générée définit entry: 'index.html' et qu'aucun autre composant ne revendique cet élément. App.xu se compile toujours vers l'identifiant de programme app.

Modifiez et enregistrez

Modifiez App.xu et enregistrez. Le surveillant recompile le projet, régénère les documents du runtime et pousse un rechargement via un canal socket.io, donc le navigateur se rafraîchit tout seul.

Effacez les guides de dossier quand vous n'en avez plus besoin

bash
npm run clean:readmes

Cela ne supprime que les fichiers README que l'outil de création a générés (repérés par un marqueur interne). Tout README que vous avez écrit vous-même est laissé tel quel, et la commande indique séparément le nombre de fichiers supprimés, ignorés et manquants.

Le modèle mental : trois couches

Si xuda.config.js définit entry: 'index.html', la coque HTML est servie en premier et App.xu se monte dans #app sauf si autre chose a déjà revendiqué cet élément. Si entry est omis, xuda-cli utilise par défaut l'identifiant de programme app au lieu d'un fichier HTML.

Répartition recommandée : gardez index.html comme coque de la page, gardez App.xu comme écran racine et ajoutez les écrans de fonctionnalité sous components/.

La structure du projet

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/

Voir Le langage .xu pour ce qui va dans chaque dossier et comment le dossier où se trouve un fichier détermine son type d'unité.

xuda.config.js

js
module.exports = {
  entry: 'index.html',
  port: 3000,
  ssr: 'none',
  api_key: '',
  build_id: '',
};
Laissez build_id non défini

Définir build_id rend aussi api_key obligatoire, et cela vise un chemin de build distant qui n'a pas encore d'implémentation derrière lui, donc le projet échouera au chargement au lieu de se construire à distance.

Tout le reste concernant les commandes, les modes SSR et la synchronisation cloud se trouve dans Référence du CLI.

Documents du runtime générés

xuda-cli compile toujours les documents du runtime dans node_modules/.project_data/, un globals.json plus un fichier par programme. Les fichiers obsolètes y sont supprimés à chaque compilation. Considérez-le comme une sortie de build : les fichiers .xu et .json5 que vous écrivez sont la source de vérité.

Vous pouvez voir un dossier project_data/ ou un dossier .project_data/ à la racine dans d'anciens documents. Ce sont des chemins hérités, réservés à l'import pour la migration, jamais un endroit où écrire.