Project Scaffolding

Створіть каркас застосунку 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. Якщо у вашої організації ще немає вебсайтів, ви одразу потрапите до форми створення. Якщо вебсайти вже є, відкрийте список організацій у верхній частині бічної панелі та виберіть Створити новий вебсайт.
3. Вкажіть назву та домен вебсайту й за бажанням виберіть стартовий шаблон.
4. Натисніть Створити. Ви перейдете на /admin/<websiteId> — ідентифікатор у цій URL-адресі є ідентифікатором вебсайту, який потрібен у наступному розділі.

Де отримати API KEY та ідентифікатор вебсайту?

У панелі адміністратора:

1. Скопіюйте ідентифікатор вебсайту за допомогою кнопки «Копіювати ID» на інформаційній панелі
2. Створіть новий API KEY у розділі Налаштування > 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: створити production-збірку
bun start: запустити production-збірку
bun lint: виконати перевірку lint
bun generate-schemas: синхронізувати схеми CMS із Profound CMS