Skip to content

📦 Установка

Velund можно использовать как для старта нового проекта, так и интегрировать в существующий Vite-проект.
Ниже описаны оба сценария.


Предварительные требования

Перед началом убедитесь, что у вас установлены:

  • Node.js v18 или выше
  • Один из пакетных менеджеров: pnpm, npm, yarn
  • Рекомендуется иметь базовое понимание Vite и TypeScript

Создание нового проекта (рекомендуется)

CLI create-velund позволяет максимально быстро поднять проект с нужными настройками:

bash
pnpm create velund
# или
npm create velund@latest
# или
yarn create velund

Во время выполнения вы сможете выбрать:

  • название проекта
  • используемый шаблонизатор (Twig, Jinja, HTML и др.)
  • генератор для бэкенда (Node.js, Python, PHP)

После завершения генерации у вас будет готовая структура проекта с настроенным vite.config.ts.

👉 Следующий шаг: Базовая настройка


Добавление Velund в существующий проект

Если у вас уже есть проект на Vite, просто добавьте Velund и нужные адаптеры:

bash
pnpm add velund @zebrains/velund-twig
pnpm add @velund/node
  • velund — основной плагин
  • @zebrains/velund-twig — рендерер Twig-шаблонов
  • @velund/node — генератор библиотеки для Node.js

⚠️ Обратите внимание: для Python и PHP также есть соответствующие пакеты (@zebrains/velund-python, @zebrains/velund-php).

После установки нужно зарегистрировать рендереры и генераторы в vite.config.ts.