create-velund/README.md

Scaffolder for Velund projects (vite + velund + templates)

# create-velund

Инструмент для скаффолдинга (быстрого создания) проектов Velund.

`create-velund` — это утилита командной строки, предназначенная для быстрой настройки нового проекта на основе Velund и Vite. Она автоматизирует процесс создания начальной структуры проекта, включая предварительно настроенный файл `vite.config.ts`, примеры компонентов, а также интеграцию выбранного вами механизма шаблонизации и бэкенд-генератора.

## ✨ Основные возможности

- **Интерактивная настройка**: Проведет вас шаг за шагом через выбор шаблонизатора (Twig, Jinja, HTML) и генератора для бэкенда (Python, PHP, Node.js).
- **Автоматическая конфигурация**: Генерирует файл `vite.config.ts` со всеми необходимыми плагинами Velund и выбранными рендерерами/генераторами.
- **Готовая структура проекта**: Создает базовый пример проекта, позволяя вам сразу приступить к разработке.

## 🚀 Использование (создание нового проекта)

Вы можете использовать `create-velund` через менеджеры пакетов npm, yarn или pnpm без предварительной глобальной установки.

Чтобы создать новый проект Velund, выполните одну из следующих команд в терминале:

```bash
# С использованием npm
npm create velund@latest my-velund-app

# С использованием Yarn
yarn create velund my-velund-app

# С использованием pnpm (рекомендуется)
pnpm create velund my-velund-app
```

В процессе выполнения команды `create-velund` задаст вам несколько вопросов:

1.  **Название проекта**: Имя директории, в которой будет создан ваш новый проект.
2.  **Шаблонизатор**: Выберите между `twig`, `jinja` или `html`.
3.  **Генератор для бэкенда**: Выберите между `python`, `php` или `node`.

После ответов на вопросы `create-velund` выполнит следующие действия:

1.  Создаст директорию проекта.
2.  Установит необходимые зависимости (Vite, плагин `velund`, выбранные пакеты рендереров и генераторов).
3.  Сгенерирует `vite.config.ts` и файлы с примерами компонентов.
4.  Выведет инструкции по запуску сервера разработки.

### Пример файла `vite.config.ts`, сгенерированного `create-velund` (для Twig + Python):

```typescript
// vite.config.ts
import { defineConfig } from 'vite';
import velund from 'velund'; // Основной плагин Velund
import pythonGenerator from '@zebrains/velund-python'; // Генератор для Python
import twigRenderer from '@zebrains/velund-twig'; // Рендерер для Twig

export default defineConfig({
  plugins: [
    velund({
      renderer: 'twig',
      generator: 'python',
      renderers: [twigRenderer()], // Регистрируем экземпляры рендереров
      generators: [pythonGenerator()], // Регистрируем экземпляры генераторов
    }),
  ],
  // ... другие настройки Vite
});
```

### Следующие шаги после создания проекта

После того как проект будет создан, перейдите в его директорию и запустите сервер разработки Vite:

```bash
cd my-velund-app
# Установите зависимости, если create-velund не сделал это автоматически (редко):
# pnpm install
# npm install
# yarn install

# Запустите сервер разработки Velund:
npm run dev
# или
pnpm dev
# или
yarn dev
```

Теперь ваш проект Velund запущен, и вы можете начать определять свои UI-компоненты. Для получения более подробной информации об определении компонентов и интеграции с вашим бэкендом обратитесь к основной документации [`velund`](../velund/README.md).