Skip to content

GrayHoax/php-max-messanger-company-vcard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Max Messenger — Бот-визитка компании

PHP Max Messenger License

Бот-визитка компании для мессенджера Max — готовое решение для представления бизнеса в одном из крупнейших российских мессенджеров. Позволяет рассказать о компании, услугах, портфолио, контактах и принимать заявки от потенциальных клиентов. Весь контент управляется через единый YAML-файл без изменения кода.


Возможности

  • /start — приветствие + интерактивное меню с inline-кнопками
  • /help — справка и контакты автора бота
  • О компании — описание, год основания, численность команды
  • Услуги — список услуг с описаниями и ценами
  • Портфолио — реализованные проекты со ссылками
  • Контакты — телефон, email, сайт, адрес, соцсети
  • Оставить заявку — приём обращений от пользователей с опциональной пересылкой менеджеру
  • Весь контент редактируется в одном файле config/content.yaml — без изменения кода
  • Запуск в Docker одной командой

Отображение диалогов у пользователя

Пример главного экрана

Пример раздела Справка

Пример подачи заявки

Пример раздела Услуг

Пример раздела Контакты

Быстрый старт

Требования

  • Docker & Docker Compose или PHP 7.4+ и Composer

1. Клонировать репозиторий

git clone https://github.com/GrayHoax/php-max-messanger-company-vcard
cd max-vcard-bot

2. Настроить окружение

cp .env.example .env

Откройте .env и укажите токен бота:

BOT_TOKEN=your_bot_token_here

Получить токен можно у бота @MaxBotFather в мессенджере Max.

3. Заполнить контент компании

Откройте config/content.yaml и заполните все разделы своими данными:

company:
  name: "ООО «Ваша Компания»"
  tagline: "Слоган вашей компании"
  about: |
    Описание вашей компании...

Подробнее о структуре файла — в разделе Конфигурация контента.

4. Запустить бота

С Docker (рекомендуется):

docker compose up -d

Без Docker:

composer install
php bot.php

Конфигурация контента

Весь контент хранится в config/content.yaml. Файл разделён на секции:

Секция Описание
company Название, слоган, описание, год основания
services Список услуг с описаниями и ценами
portfolio Реализованные проекты
contacts Телефон, email, сайт, адрес, соцсети
request Настройки раздела «Оставить заявку»
bot Тексты бота и контакты автора

Пересылка заявок менеджеру

Укажите chat_id менеджера в секции request:

request:
  manager_chat_id: "123456789"

Узнать chat_id можно, написав боту любое сообщение и проверив логи, или воспользовавшись ботом @MaxIDBot.


Структура проекта

max-vcard-bot/
├── config/
│   └── content.yaml       # Весь контент компании
├── src/
│   ├── Bot/
│   │   └── VCardBot.php   # Основной класс бота
│   ├── Config/
│   │   └── ContentLoader.php  # Загрузчик YAML-конфигурации
│   └── Formatter/
│       └── MessageFormatter.php  # Форматирование сообщений
├── bot.php                # Точка входа
├── composer.json
├── Dockerfile
├── docker-compose.yml
├── .env.example
└── README.md

Технологии

  • PHP 7.4+ — основной язык
  • grayhoax/phpmaxbot — фреймворк для работы с Max Bot API
  • symfony/yaml — парсинг YAML-конфигурации
  • vlucas/phpdotenv — управление переменными окружения
  • Docker — контейнеризация для простого деплоя

Деплой на сервер

Для production-запуска на VPS:

# Клонировать репозиторий
git clone https://github.com/GrayHoax/php-max-messanger-company-vcard
cd max-vcard-bot

# Настроить окружение и контент
cp .env.example .env && nano .env
nano config/content.yaml

# Запустить
docker compose up -d

# Просмотр логов
docker compose logs -f

Обновление контента

После изменения config/content.yaml перезапуск бота не требуется — файл смонтирован как volume и читается при каждом обращении пользователя.


Лицензия

Данный проект распространяется на условиях Source Available License with Restricted Commercial Use.

  • ✅ Некоммерческое использование — разрешено
  • ✅ Изучение и модификация — разрешено
  • ❌ Коммерческое использование — требует письменного согласования с автором

По вопросам коммерческого использования обращайтесь: github.com/GrayHoax


Автор

GrayHoaxgithub.com/GrayHoax

Если бот помог вашему бизнесу — поставьте ⭐ репозиторию!

About

Бот-визитка компании для мессенджера Max. Позволяет рассказать о компании, услугах, портфолио, контактах и принимать заявки от потенциальных клиентов.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors