profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

Quick startJSON 与 Claude 代码组件 Zod 拉取

REST API

REST API 概览get连接网站 APIgetGET /routesgetGET /routegetGET /blocksget获取带有 CEL 缓存的区块getGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}get获取内容变更 SSEpatchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatch修补 CSV
All Systems Operational
Powered Byprofound-logo
Theme

Project Scaffolding

搭建预配置 Profound CMS 的网站,提供最小启动模板或文档网站模板。

为 Profound CMS 搭建 Next.js / TanStack 应用骨架。

安装和运行

使用 Bun 创建新项目:

bunx create-profound-app <project-name>

你可以交互式选择模板,也可以明确指定模板:

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

跳过自动初始化 Git:

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

跳过自动安装 依赖:

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

后续步骤

cd <project-name>
bun dev

模板

  • base:适用于 Profound CMS 的最小网站启动模板。
  • docs:带有文档专用 UI 的文档网站启动模板。

在 Profound CMS 中创建网站

生成的应用需要一个要连接的网站。在设置环境变量之前,请先在管理面板中创建一个网站。

  1. 前往 管理面板。
  2. 如果你的组织还没有网站,你会直接进入创建表单。否则,打开侧边栏顶部的组织下拉菜单,然后选择 创建新网站。
  3. 为网站填写名称和域名,也可以选择一个启动模板。
  4. 点击 创建。你将进入 /admin/<websiteId> — 该 URL 中的 ID 就是下一节所需的网站 ID。

在哪里获取 API KEY 和网站 ID?

在管理面板中:

  1. 在仪表板上点击 “复制 ID” 按钮,复制网站 ID
  2. 在 设置 > API 密钥 部分创建新的 API KEY

环境变量

在生成的网站中创建 .env.local 文件:

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

功能说明

create-profound-app 会将模板复制到新目录中,替换项目名称等模板占位符,并根据需要初始化 Git 仓库和安装所需依赖。

生成的网站命令

在生成的项目中,主要命令如下:

bun dev: 启动开发服务器
bun build: 构建生产版本
bun start: 运行生产构建
bun lint: 执行代码检查
bun generate-schemas: 从 Profound CMS 同步 CMS 架构
Continue Reading
Previous‹CEL Scripting in Template BuilderNextMedia Library›