PhoDoc Docs

Appearance

PhoDoc DocsДокументация PhoDoc

Руководство по production WebApp, Telegram WebApp, шаблонам DOCX, заказам, клиентам, доставке документов и администрированию сервиса.

Быстрый старт
Деплой docs
PhoDoc

Клиенты и заказы

Ведение клиентской базы, создание заказов, клиентские ссылки и история сгенерированных документов.

Шаблоны DOCX

Пользовательские поля, переменные, вычисляемые значения, загрузка DOCX и скачивание variables.txt.

Доставка документов

Генерация DOCX/PDF, скачивание, отправка в Telegram и email с учетом привязки аккаунтов.

Telegram и Web

Авторизация через initData, Telegram Login Widget и email, различия Telegram WebApp и обычного браузера.

Что такое PhoDoc ​

PhoDoc - сервис для специалистов и малого бизнеса, которым нужно регулярно оформлять договоры и связанные документы. Пользователь ведет клиентов, настраивает шаблоны договоров, создает заказы, генерирует DOCX/PDF и отправляет документы себе или клиенту.

Основной источник пользовательской логики - production WebApp в public/app.js. Отдельная Vue/Vite-часть в frontend/src сейчас является упрощенным desktop/web-интерфейсом и не должна восприниматься как полная production-функциональность.

Для кого ​

  • фотографы, видеографы, фрилансеры и самозанятые;
  • специалисты, которые часто создают однотипные договоры;
  • малый бизнес, которому нужна легкая CRM для клиентов, заказов и документов;
  • администраторы PhoDoc, которые обслуживают деплой, домены, подписки, почту и платежи.

Основные сценарии ​

  1. Пользователь входит через Telegram WebApp, Telegram Login Widget или email.
  2. Заполняет профиль, email, Telegram-привязку и уведомления.
  3. Добавляет клиента или выбирает клиента из подсказок при создании заказа.
  4. Создает шаблон договора, настраивает поля и загружает DOCX.
  5. Создает заказ, проверяет предпросмотр, сохраняет и генерирует документы.
  6. Скачивает DOCX/PDF, отправляет файлы или ссылку в Telegram/email.

Интерфейсы ​

Telegram WebApp открывается из Telegram и авторизуется через initData. Для него критичны HTTPS, корректный домен в BotFather и переменные TELEGRAM_WEBAPP_URL, WEBAPP_URL/WEB_APP_URL, BASE_URL.

Обычная web-версия открывается в браузере и поддерживает email-вход, Telegram Login Widget, профиль, клиентов, шаблоны, заказы, доставку, подписки и админ-разделы при роли администратора.

Desktop/web-интерфейс из frontend/src показывает отдельный Vue/Vite UI с дашбордом, шаблонами, договорами и настройками, но по коду выглядит демонстрационным и не покрывает весь production API.

Разделы ​

Документация основана на production WebApp и NestJS API PhoDoc.

PhoDoc