Saltar para o conteúdo
Verificado

Instalar e criar um projeto

Crie um projeto Xuda CLI com um só comando e depois aprenda para que serve cada ficheiro gerado.

Antes de começar

O caminho da CLI precisa do Node.js 18.17.0 ou posterior, que é o mínimo de motor que o xuda-cli declara. Mais nada: o próprio xuda-cli depende de três pacotes (express, socket.io, chokidar), e o gerador que cria um novo projeto não tem dependências próprias. O desenvolvimento local nunca chama um método condicionado por plano, por isso criar uma aplicação desta forma não custa nada.

Crie uma nova aplicação

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

Veja o que o create-xuda-cli escreveu

O gerador escreve um package.json que já declara @xuda.io/xuda-framework-plugin-tailwind e @xuda.io/xuda-dbs-plugin-xuda como dependências e xuda-cli como dependência de desenvolvimento, um xuda.config.js, App.xu, index.html, uma pasta components/ e um primeiro node_modules/.project_data/globals.json. Deixa também um guia README.md gerado em doze pastas: as onze pastas-fonte por tipo mais uma para o próprio data/, cada uma removível mais tarde.

Abra a aplicação

npm run dev imprime o URL em que escuta, http://localhost:3000 por predefinição. O index.html é servido como a estrutura base e o App.xu monta-se em #app automaticamente, porque a configuração gerada define entry: 'index.html' e nenhum outro componente reclama esse elemento. O App.xu compila sempre para o id de programa app.

Edite e guarde

Edite o App.xu e guarde. O observador recompila o projeto, regenera os documentos de runtime e envia um recarregamento por um canal socket.io, por isso o navegador atualiza-se sozinho.

Limpe os guias das pastas quando já não precisar deles

bash
npm run clean:readmes

Isto só elimina os ficheiros README que o gerador criou (identificados por uma marca interna). Qualquer README que tenha escrito fica como está, e o comando indica separadamente as contagens de removidos, ignorados e em falta.

O modelo mental: três camadas

Se o xuda.config.js definir entry: 'index.html', a estrutura HTML é servida primeiro e o App.xu monta-se em #app, a menos que outra coisa já tenha reclamado esse elemento. Se entry for omitido, o xuda-cli usa por predefinição o id de programa app em vez de um ficheiro HTML.

Divisão recomendada: mantenha o index.html como a estrutura base da página, o App.xu como o ecrã de raiz e adicione ecrãs de funcionalidades em components/.

A estrutura do projeto

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/

Veja A linguagem .xu para saber o que pertence a cada pasta e como a pasta em que um ficheiro está decide o seu tipo de unidade.

xuda.config.js

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

Definir build_id torna também api_key obrigatória, e aponta para um caminho de compilação remota que ainda não tem implementação por trás, por isso o projeto falhará ao carregar em vez de compilar remotamente.

Tudo o resto sobre comandos, modos SSR e sincronização com a cloud está em A referência da CLI.

Documentos de runtime gerados

O xuda-cli compila sempre os documentos de runtime para node_modules/.project_data/, um globals.json mais um ficheiro por programa. Os ficheiros obsoletos aí presentes são eliminados em cada compilação. Trate-a como saída de compilação: os ficheiros .xu e .json5 que escreve são a fonte da verdade.

Pode encontrar uma pasta project_data/ ou uma pasta .project_data/ na raiz em material mais antigo. Esses são caminhos legados apenas de importação, mantidos para migração, nunca um sítio onde escrever.