diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..2f85c4b --- /dev/null +++ b/Home.md @@ -0,0 +1,43 @@ +# Aspekter VA — Визуальный конструктор email + +Внутренний инструмент для сборки email-рассылок VipAvenue. Позволяет собирать письма из готовых блоков, рендерить Pug-шаблоны в HTML, управлять рассылками через интеграцию с Yonote, загружать картинки на FTP/SFTP, проверять орфографию и ссылки. + +## Навигация по документации + +| Раздел | Описание | +|--------|----------| +| [Архитектура](Architecture) | Структура проекта, цепочка рендера, хранение данных | +| [Блоки и шаблоны](Blocks) | Типы блоков, поля, схемы, шаблоны, кастомные блоки | +| [Гендерная сегментация](Gender) | Жен/Муж версии, flip, swapCenter, ID pool | +| [Рендер и постобработка](Rendering) | PUG→HTML, кэш, Mindbox, nowrap, preheader | +| [Фид товаров](Feed) | YML-фид, кэш, подстановка Mindbox-тегов, замена товаров | +| [FTP/SFTP галерея](FTP) | Загрузка картинок, галерея, автонумерация | +| [План рассылок](Plan) | Yonote интеграция, календарь, карточка сборки | +| [Редактор хедера/футера](Parts-Editor) | Парсинг pug, редактирование кнопок и ссылок | +| [Проверки качества](Quality) | Спеллчекер, проверка ссылок, типограф | +| [Пользователи и безопасность](Security) | Авторизация, роли, аудит, защита от инъекций | +| [API Reference](API) | Полный список эндпоинтов бэкенда | +| [Docker и деплой](Docker) | Контейнеры, volumes, сборка, деплой на сервер | +| [Frontend State](Frontend-State) | Все переменные состояния, localStorage, cookies | +| [Парсинг и утилиты](Parsing) | Библиотека parsing.js — разбор Pug, миксинов, секций | + +## Стек технологий + +- **Frontend:** Svelte 5 (SPA, один файл App.svelte ~6500 строк) +- **Backend:** Vite 7 middleware plugin (vite.config.js ~1600 строк) — НЕ Express/Koa, а встроенный в Vite +- **Шаблоны:** Pug (email-gen — репозиторий коллег) +- **Рендер:** email-gen-api — отдельный микросервис на Node.js (порт 8787) +- **Хранение:** файловая БД (JSON-файлы в `data/`) +- **Деплой:** Docker, nginx, Let's Encrypt +- **Сервер:** Timeweb Cloud VPS, Ubuntu 24.04 +- **Домен:** va.aspekter.ru + +## Быстрый старт + +```bash +git clone https://git.aspekter.ru/s.zotov/va-aspekter.git +cd va-aspekter +docker compose up -d +# Открыть http://localhost:6001 +# Пароль admin — в логах: docker logs vaaspekter-builder-1 2>&1 | grep "Временный пароль" +```