Saltar al contenido
Verificada

Instalar y crear un proyecto

Genera un proyecto de Xuda CLI con un solo comando y descubre para qué sirve cada archivo generado.

Antes de empezar

El camino de la CLI necesita Node.js 18.17.0 o superior, que es el mínimo del motor que declara xuda-cli. Nada más: xuda-cli en sí depende de tres paquetes (express, socket.io, chokidar), y el generador que crea un proyecto nuevo no tiene dependencias propias. El desarrollo local nunca llama a un método sujeto a plan, así que crear una app de este modo no cuesta nada.

Genera una app nueva

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

Mira lo que escribió create-xuda-cli

El generador escribe un package.json que ya declara @xuda.io/xuda-framework-plugin-tailwind y @xuda.io/xuda-dbs-plugin-xuda como dependencias y xuda-cli como dependencia de desarrollo, un xuda.config.js, App.xu, index.html, una carpeta components/ y un primer node_modules/.project_data/globals.json. También deja una guía README.md generada en doce carpetas: las once carpetas de código fuente tipadas más una para la propia data/, y cada una se puede eliminar después.

Abre la app

npm run dev imprime la URL en la que escucha, http://localhost:3000 por defecto. index.html se sirve como shell y App.xu se monta en #app automáticamente, porque la configuración generada define entry: 'index.html' y ningún otro componente reclama ese elemento. App.xu siempre se compila con el id de programa app.

Edita y guarda

Edita App.xu y guarda. El observador recompila el proyecto, regenera los documentos del runtime y envía una recarga por un canal socket.io, así que el navegador se actualiza solo.

Borra las guías de las carpetas cuando ya no las necesites

bash
npm run clean:readmes

Esto solo elimina los archivos README que generó el generador (rastreados mediante una marca interna). Cualquier README que hayas escrito tú se deja en paz, y el comando informa por separado de los recuentos de eliminados, omitidos y ausentes.

El modelo mental: tres capas

Si xuda.config.js define entry: 'index.html', el shell HTML se sirve primero y App.xu se monta en #app salvo que otra cosa ya haya reclamado ese elemento. Si se omite entry, xuda-cli usa por defecto el id de programa app en lugar de un archivo HTML.

División recomendada: mantén index.html como shell de la página, mantén App.xu como pantalla raíz y añade las pantallas de cada función dentro de components/.

La estructura del proyecto

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/

Consulta El lenguaje .xu para saber qué corresponde a cada carpeta y cómo la carpeta en la que está un archivo decide su tipo de unidad.

xuda.config.js

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

Definir build_id hace también obligatoria api_key, y apunta a una ruta de compilación remota que todavía no tiene ninguna implementación detrás, así que el proyecto fallará al cargar en lugar de compilarse de forma remota.

Todo lo demás sobre comandos, modos SSR y sincronización con la nube está en Referencia de la CLI.

Documentos de runtime generados

xuda-cli siempre compila los documentos de runtime en node_modules/.project_data/, un globals.json más un archivo por programa. Los archivos obsoletos de ahí se eliminan en cada compilación. Trátalo como salida de compilación: los archivos .xu y .json5 que escribes son la fuente de verdad.

Puede que veas una carpeta project_data/ o una carpeta .project_data/ en la raíz en material antiguo. Son rutas heredadas, solo de importación, que se conservan para migrar, nunca un lugar donde escribir.