InviteMe Developer
83 lines
3.0 KiB
Markdown
83 lines
3.0 KiB
Markdown
# InviteMe
|
|
|
|
Приложение для регистрации гостей на корпоративные мероприятия. Аналог Timepad с упрощённым функционалом.
|
|
|
|
## Возможности
|
|
|
|
- Загрузка списка гостей из Excel
|
|
- Хранение фото гостей и привязка по названию файла
|
|
- Генерация персональных QR-кодов
|
|
- Автоматическая рассылка приглашений на email
|
|
- Ручное добавление/удаление/блокировка участников
|
|
- Проверка входа по QR-коду или поиску по ФИО
|
|
- Аналитика посещаемости для администратора
|
|
- Выгрузка отчётов в Excel
|
|
|
|
## Стек
|
|
|
|
- Python 3.10+
|
|
- Flask + Flask-SQLAlchemy
|
|
- SQLite
|
|
- Bootstrap 5
|
|
- html5-qrcode
|
|
- SMTP
|
|
|
|
## Быстрый старт
|
|
|
|
```bash
|
|
cd C:\Projects\Integrita\InviteMe
|
|
python -m venv venv
|
|
venv\Scripts\activate
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
Создайте файл `.env` в корне проекта (см. `docs/DEPLOY.md`) и запустите:
|
|
|
|
```bash
|
|
flask --app run.py run --host=0.0.0.0 --port=5000
|
|
```
|
|
|
|
## Учётные записи по умолчанию
|
|
|
|
- Админ: `admin` / `admin`
|
|
- Сотрудник на входе: `staff` / `staff`
|
|
|
|
> Обязательно смените пароли в production через переменные окружения или `.env`.
|
|
|
|
## Структура проекта
|
|
|
|
```
|
|
InviteMe/
|
|
├── app/
|
|
│ ├── __init__.py
|
|
│ ├── models.py # Модели Guest и CheckIn
|
|
│ ├── routes.py # Все маршруты приложения
|
|
│ ├── services/ # QR, email, Excel
|
|
│ ├── static/
|
|
│ │ ├── css/
|
|
│ │ ├── js/
|
|
│ │ └── uploads/ # Фото и QR-коды
|
|
│ └── templates/
|
|
│ ├── admin/
|
|
│ ├── checkin/
|
|
│ └── email/
|
|
├── config.py # Конфигурация
|
|
├── docs/
|
|
│ └── DEPLOY.md # Подробная инструкция по развёртыванию
|
|
├── requirements.txt
|
|
├── run.py
|
|
└── README.md
|
|
```
|
|
|
|
## Контекст проекта
|
|
|
|
Проект разрабатывается для компании **Integrita**. Планируется развёртывание на виртуальной машине.
|
|
|
|
- Подробный контекст, бизнес-процесс и чеклист — в `docs/CONTEXT.md`.
|
|
- Инструкции по настройке SMTP, запуску в production и резервному копированию — в `docs/DEPLOY.md`.
|
|
|
|
## Ссылки на документацию
|
|
|
|
- `docs/CONTEXT.md` — контекст, роли, поток данных, чеклист
|
|
- `docs/DEPLOY.md` — развёртывание, настройка SMTP, запуск в production
|