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

Требования к окружению, установка зависимостей и команды разработки.

Требования

Инструмент	Версия	Где зафиксировано
Node.js	24 или новее	`package.json` → `engines`, `.nvmrc`
pnpm	11.7 или новее	`package.json` → `packageManager`
Docker	любая актуальная	опционально, для публикации

Установка

pnpm install

Скрипт postinstall запускает fumadocs-mdx и генерирует каталог .source/ — типы и коллекции документации. Без него сборка не найдет модуль collections/server.

Разработка

pnpm dev

портал — http://localhost:3000;
документация — http://localhost:3000/docs.

Изменения в .mdx-файлах и meta.json подхватываются без перезапуска сервера.

Проверки перед коммитом

pnpm types:check

pnpm build

types:check последовательно выполняет генерацию коллекций Fumadocs, генерацию типов маршрутов Next.js и проверку TypeScript. Обе команды выполняются в CI (.github/workflows/ci.yml), поэтому локальный прогон экономит цикл сборки.

Каталоги, которые нельзя править вручную

.source/, .next/, node_modules/ и tsconfig.tsbuildinfo генерируются инструментами. Они исключены из репозитория через .gitignore.

Запуск в Docker

docker compose up --build

Compose собирает production-образ по Dockerfile и публикует порт 3000. Переменные окружения перечислены в .env.example.

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

Переменная	Назначение	Значение по умолчанию
`NEXT_PUBLIC_SITE_URL`	Базовый адрес портала. Используется в `metadataBase` и Open Graph-ссылках.	`http://localhost:3000`
`PORT`	Порт HTTP-сервера Next.js.	`3000`
`HOSTNAME`	Интерфейс прослушивания. В контейнере обязателен `0.0.0.0`.	`0.0.0.0`