profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialБлогPhilosophy
DocsTutorialБлогPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyНаписание скриптов в конструкторе шаблоновProject ScaffoldingМедиатека

Без интерфейса

Быстрый стартSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Обзор REST APIgetConnect your websitegetПолучить маршрутыgetGET /routegetПолучение блоковgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetПолучить компонентыgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Project Scaffolding

Создайте веб-сайт, предварительно настроенный для Profound CMS, используя минимальный стартовый шаблон или шаблон сайта документации.

Создайте каркас приложения Next.js / TanStack для Profound CMS.

Установка и запуск

Используйте 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: стартовый шаблон сайта документации со специализированным интерфейсом.

Создание веб-сайта в Profound CMS

Для работы с созданным приложением необходимо указать веб-сайт. Создайте его в панели администратора, прежде чем задавать переменные окружения.

  1. Перейдите в панель администратора.
  2. Если в вашей организации ещё нет веб-сайтов, вы сразу попадёте на форму создания. В противном случае откройте список организаций в верхней части боковой панели и выберите Create new website.
  3. Укажите название и домен веб-сайта, а также при желании выберите стартовый шаблон.
  4. Нажмите Create. Вы перейдёте на страницу /admin/<websiteId> — идентификатор в этом URL является ID веб-сайта, который требуется в следующем разделе.

Где получить API KEY и ID веб-сайта?

В панели администратора:

  1. Скопируйте ID веб-сайта с помощью кнопки «Copy ID» на панели управления
  2. Создайте новый API KEY в разделе Settings > API Keys

Переменные окружения

Создайте файл .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: синхронизировать схемы CMS из Profound CMS
Continue Reading
Previous‹Написание скриптов в конструкторе шаблоновNextМедиатека›