Project Scaffolding

Skapa en Next.js-/TanStack-app för Profound CMS.

Installera och kör

Använd Bun för att skapa ett nytt projekt:

bunx create-profound-app <project-name>

Du kan välja en mall interaktivt eller ange en uttryckligen:

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

Så här hoppar du över automatisk initiering av Git:

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

Så här hoppar du över automatisk installation av beroenden:

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

Nästa steg

cd <project-name>
bun dev

Mallar

• base: minimal webbplatsmall för Profound CMS.
• docs: startmall för en dokumentationswebbplats med UI som är särskilt anpassat för dokumentation.

Skapa webbplatsen i Profound CMS

Den skapade appen behöver en webbplats att ansluta till. Skapa en i administrationspanelen innan du konfigurerar dina miljövariabler.

1. Gå till Administrationspanelen.
2. Om din organisation ännu inte har några webbplatser kommer du direkt till formuläret för att skapa en. Annars öppnar du organisationsmenyn högst upp i sidofältet och väljer Skapa ny webbplats.
3. Ange ett namn och en domän för webbplatsen och välj eventuellt en startmall.
4. Klicka på Skapa. Du skickas till /admin/<websiteId> — ID:t i den URL:en är webbplats-ID:t som efterfrågas i nästa avsnitt.

Var hittar jag API-NYCKELN och webbplats-ID:t?

Från administrationspanelen:

1. Kopiera webbplats-ID:t från knappen ”Kopiera ID” på kontrollpanelen
2. Skapa en ny API-NYCKEL i avsnittet Inställningar > API-nycklar

Miljövariabler

Skapa en .env.local-fil i den genererade webbplatsen:

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

Vad den gör

create-profound-app kopierar en mall till en ny katalog, ersätter platshållare i mallen, till exempel projektnamnet, och initierar eventuellt ett Git-arkiv samt installerar nödvändiga beroenden.

Kommandon för den genererade webbplatsen

I det genererade projektet är de viktigaste kommandona:

bun dev: starta utvecklingsservern
bun build: bygg för produktion
bun start: kör produktionsbygget
bun lint: kör lintning
bun generate-schemas: synkronisera CMS-scheman från Profound CMS