Project Scaffolding

Estruture um app Next.js / TanStack para o Profound CMS.

Instalar e executar

Use o Bun para criar um novo projeto:

bunx create-profound-app <project-name>

Você pode escolher um template interativamente ou passar um explicitamente:

bunx create-profound-app <project-name> --framework=next/tanstack --template=base/docs

Para ignorar a inicialização automática do Git:

bunx create-profound-app <project-name> --no-git

Para ignorar a instalação automática das dependências:

bunx create-profound-app <project-name> --no-install

Próximas etapas

cd <project-name>
bun dev

Templates

• base: ponto de partida minimalista para sites no Profound CMS.
• docs: ponto de partida para sites de documentação, com interface específica para documentação.

Criar o site no Profound CMS

O app estruturado precisa de um site para apontar. Crie um no Painel de administração antes de configurar as variáveis de ambiente.

1. Acesse o Painel de administração.
2. Se sua organização ainda não tiver sites, você será direcionado diretamente ao formulário de criação. Caso contrário, abra o menu suspenso da organização na parte superior da barra lateral e escolha Criar novo site.
3. Dê um nome e um domínio ao site e, opcionalmente, escolha um template inicial.
4. Clique em Criar. Você será levado para /admin/<websiteId> — o ID nessa URL é o ID do site solicitado na próxima seção.

Onde obter a CHAVE DE API e o ID do site?

No Painel de administração:

1. Copie o ID do site usando o botão "Copiar ID" no painel
2. Crie uma nova CHAVE DE API na seção Configurações > Chaves de API

Variáveis de ambiente

Crie um arquivo .env.local no site gerado:

PROFOUND_API_KEY=your_api_key
NEXT_PUBLIC_PROFOUND_WEBSITE_ID=your_website_id
NEXT_PUBLIC_CMS_API_URL=https://cms.dev.tryprofound.com
NEXT_PUBLIC_BUNNY_CDN_URL=https://cms-profound.b-cdn.net

O que ele faz

create-profound-app copia um template para um novo diretório, substitui placeholders do template, como o nome do projeto, e, opcionalmente, inicializa um repositório Git e instala as dependências necessárias.

Comandos do site gerado

Dentro do projeto gerado, os principais comandos são:

bun dev: iniciar o servidor de desenvolvimento
bun build: gerar a versão de produção
bun start: executar a versão de produção
bun lint: executar a verificação de lint
bun generate-schemas: sincronizar os esquemas do CMS a partir do Profound CMS