Project Scaffolding

Scaffold a Next.js / TanStack app for Profound CMS.

Install and Run

Use Bun to create a new project:

bunx create-profound-app <project-name>

You can choose a template interactively, or pass one explicitly:

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

To skip automatic Git initialization:

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

To skip automatic dependencies installation:

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

Next Steps

cd <project-name>
bun dev

Templates

• base: minimal website starter for Profound CMS.
• docs: documentation site starter with docs-specific UI.

Where to get API KEY and website ID?

From the Admin Panel:

1. Copy Website ID from the dashboard "Copy ID" button on the dashboard
2. Create a new API KEY in Settings > API Keys Section

Environment Variables

Create a .env.local file in your generated website:

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

What It Does

create-profound-app copies a template into a new directory, replaces template placeholders such as the project name, and optionally initializes a Git repository and installs required dependencies.

Generated Website Commands

Inside the generated project, the main commands are:

bun dev: start the development server
bun build: build for production
bun start: run the production build
bun lint: run linting
bun generate-schemas: sync CMS schemas from Profound CMS