Quickstart
Do zero a um app Fayz rodando no seu navegador em cinco minutos. Você instala a CLI, gera um app admin, instala as dependências, sobe o dev server e vê a coisa funcionando — tudo em modo mock, sem configurar nenhuma variável de ambiente.
Pré-requisitos
- Node ≥ 20 e npm (vêm juntos). Confira com
node -v. - Uma conta Supabase — opcional, só para o último passo, quando você quiser trocar o mock por dados reais. Para o quickstart em si, você não precisa de nada além do Node.
1. Instale a CLI
npm i -g @fayz-ai/cli
Confira que funcionou com fayz --version.
2. Crie o app
fayz create admin minha-app
Isso gera um projeto minha-app/ — um app admin com o plugin de dashboard já ligado, apontado para faixas caret (^) de um conjunto coerente de pacotes @fayz-ai/* — o canal stable — e em modo mock. O comando não instala nada nem sobe servidor: ele só escreve os arquivos e te diz os próximos passos.
3. Instale e suba o dev server
cd minha-app npm install npm run dev
Checkpoint. Abra http://localhost:5173. O app sobe em modo mock: dados de exemplo, autenticação simulada, zero env. Você navega pelo shell, abre plugins e vê telas reais sem tocar em Supabase. É o ponto de partida de todo app Fayz — e é aqui que você vai personalizar tema, plugins e conteúdo antes de sequer pensar em backend.
Consumindo os pacotes em código e quer telas populadas? Os providers mock nascem vazios — veja Mock e dados de exemplo para os seams de seed.
O que você acabou de montar
Um app Fayz completo, descrito por app.manifest.json: o shell de admin, a navegação, e o plugin de dashboard — tudo renderizado pelo runtime a partir desse manifesto. Personalizar daqui para frente é, na maioria das vezes, editar o manifesto: renomear o app, trocar o tema, ligar mais plugins. Nada de reescrever telas.
Próximo passo
O tutorial pega esse mesmo app e leva do primeiro comando ao deploy — tema, plugins, dados reais e um plugin seu — em sete passos.