create-nectar-app

Scaffold de um app do Nectar Dev Center a partir dos templates oficiais.

npm create nectar-app my-app
cd my-app
npx @nectarcrm/cli dev

Sem argumentos, o comando pergunta o nome do app e o template. Para pular o prompt:

npm create nectar-app my-app -- --template product-editor --yes

Templates

| id | O que gera | |---|---| | basic | Ponto de partida limpo: painel com status de conexão, eventos do CRM e um toast de exemplo. | | custom-module | Item no menu do CRM que abre uma página própria (dashboard standalone). | | product-editor | Painel no contexto de um produto: edita campos, valida no servidor e aplica estilo/badge em campos customizados. | | rest-starter | Base para integrar com qualquer API REST: painel de teste que dispara GET/POST via connector, com a chamada isolada numa function. | | contact-sync | Sincroniza contatos de um sistema externo para o CRM — por cron ou sob demanda, idempotente via mapeamento de IDs. |

O que ele cria

Além dos arquivos do template: nectar.config.json, .env.example (onde ficam as NECTAR_API_KEY_<ENV> — o .env real nunca é versionado), .gitignore e fixtures/ para o emulador offline.

No fim ele oferece configurar a publicação: pergunta o Dev Center, conduz o login (abre o browser) e então cria o app lá — ou vincula a um existente — emitindo a API key sozinho. Nenhum uuid ou chave para copiar. Dá para pular e rodar npx @nectarcrm/cli login depois.

O passo seguinte é o @nectarcrm/cli: nectar dev para o inner loop local, nectar deploy --env <env> para publicar.

Docs: https://developer.nectarcrm.com.br/docs/testing-locally · CLI: https://developer.nectarcrm.com.br/docs/cli