Initial commit: InviteMe event registration app

2026-08-28 12:28:52 +03:00
commit b4e10b8448
23 changed files with 1718 additions and 0 deletions
@@ -0,0 +1,108 @@
+# Руководство по развёртыванию InviteMe
+
+## Системные требования
+
+- Windows Server / Windows 10+ / Linux
+- Python 3.10 или новее
+- Доступ в интернет для отправки писем (SMTP)
+
+## Установка на Windows
+
+### 1. Подготовка окружения
+
+```cmd
+cd C:\Projects\Integrita\InviteMe
+python -m venv venv
+venv\Scripts\activate
+pip install -r requirements.txt
+```
+
+### 2. Настройка конфигурации
+
+Создайте файл `.env` в корне проекта:
+
+```env
+SECRET_KEY=your-strong-secret-key-here
+ADMIN_USERNAME=admin
+ADMIN_PASSWORD=your-admin-password
+STAFF_USERNAME=staff
+STAFF_PASSWORD=your-staff-password
+
+MAIL_SERVER=smtp.yandex.ru
+MAIL_PORT=465
+MAIL_USE_SSL=true
+MAIL_USERNAME=your-email@yandex.ru
+MAIL_PASSWORD=your-app-password
+MAIL_DEFAULT_SENDER=your-email@yandex.ru
+```
+
+> Для Yandex Mail используйте пароль приложения, а не основной пароль.
+
+### 3. Запуск в режиме разработки
+
+```cmd
+flask --app run.py run --host=0.0.0.0 --port=5000
+```
+
+Откройте в браузере: `http://localhost:5000`
+
+### 4. Запуск в production
+
+Для production рекомендуется использовать WSGI-сервер:
+
+```cmd
+pip install waitress
+waitress-serve --host=0.0.0.0 --port=5000 run:app
+```
+
+Или через PowerShell:
+
+```powershell
+waitress-serve --host=0.0.0.0 --port=5000 run:app
+```
+
+### 5. Доступ с других устройств
+
+- Убедитесь, что порт 5000 открыт в брандмауэре
+- Используйте IP-адрес сервера в локальной сети
+- Для QR-кодов укажите внешний URL при загрузке Excel или в `.env`:
+
+```env
+BASE_URL=https://your-domain-or-ip
+```
+
+### 6. Резервное копирование
+
+Важные данные для бэкапа:
+- `instance/inviteme.db` — база данных
+- `app/static/uploads/photos/` — фото гостей
+- `app/static/uploads/qrcodes/` — QR-коды
+- `.env` — конфигурация
+
+## Инструкция для сотрудников на входе
+
+1. Откройте `http://<ip-сервера>:5000/check-in`
+2. Войдите под учётной записью staff
+3. Для проверки QR:
+   - Нажмите «Включить камеру»
+   - Наведите на QR-код гостя
+4. Для поиска по ФИО:
+   - Введите фамилию в поле поиска
+   - Выберите нужного человека из списка
+5. Сверьте фото в программе с гостем
+6. Нажмите «Отметить вход»
+
+## Устранение неполадок
+
+### Письма не отправляются
+- Проверьте настройки SMTP в `.env`
+- Убедитесь, что используется пароль приложения (для Yandex/Google)
+- Проверьте логи в консоли
+
+### QR-код ведёт на localhost
+- При загрузке Excel укажите базовый URL сервера
+- Или добавьте `BASE_URL` в `.env`
+
+### Фото не отображаются
+- Проверьте, что название фото в Excel совпадает с именем файла (с расширением)
+- Фото должны быть в папке `app/static/uploads/photos/`