form-to-telegram

KO | EN

gitlite — search

#python #hacktoberfest #rust #deep-learning #java #windows #awesome #cli #kubernetes #vue #awesome-list #security #pytorch #ios

form-to-telegram

(★ 27)

Микросервис для сбора заявок с сайтов и мгновенной отправки уведомлений в Telegram

form-to-telegram 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Form to Telegram

[![CI](https://github.com/Varke/form-to-telegram/actions/workflows/ci.yml/badge.svg)](https://github.com/Varke/form-to-telegram/actions/workflows/ci.yml)
[![Python 3.13](https://img.shields.io/badge/python-3.13-blue.svg)](https://www.python.org/downloads/)
[![FastAPI](https://img.shields.io/badge/FastAPI-0.115+-009688.svg)](https://fastapi.tiangolo.com)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)

Микросервис для сбора заявок с сайтов и мгновенной отправки уведомлений в Telegram.

## Зачем это нужно?

Вы создали лендинг или сайт с формой обратной связи. Клиент оставляет заявку — и вы **мгновенно** получаете уведомление в Telegram со всеми данными. Никаких задержек, никаких пропущенных лидов.

### Для кого этот проект?

- **Владельцы лендингов** — получайте заявки прямо в Telegram
- **Маркетологи** — мгновенная реакция на лиды повышает конверсию
- **Разработчики** — готовый backend для любых форм на сайте
- **Фрилансеры** — быстрое решение для клиентских проектов

### Преимущества

- **Мгновенные уведомления** — заявка приходит в Telegram за секунды
- **Любые поля формы** — принимает JSON с произвольной структурой
- **Надёжное хранение** — все заявки сохраняются в PostgreSQL
- **Готов к продакшену** — Docker, миграции, логирование, health-check
- **Простая интеграция** — один POST-запрос с вашего сайта

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

### 1. Клонируйте репозиторий

```bash
git clone https://github.com/Varke/form-to-telegram.git
cd form-to-telegram
```

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

```bash
cp .env.example .env
```

Отредактируйте `.env`:
```env
BOT_TOKEN=ваш_токен_бота
ADMIN_CHAT_ID=ваш_chat_id
```

**Как получить токен бота?**
1. Напишите [@BotFather](https://t.me/BotFather) в Telegram
2. Отправьте `/newbot` и следуйте инструкциям
3. Скопируйте токен

**Как узнать свой Chat ID?**
1. Напишите [@userinfobot](https://t.me/userinfobot) в Telegram
2. Он пришлёт ваш ID

### 3. Запустите

```bash
docker compose up -d
```

Готово! API доступен на `http://localhost:8000`

## Использование

### Отправка формы

```bash
curl -X POST http://localhost:8000/api/form/submit \
  -H "Content-Type: application/json" \
  -d '{"name":"Иван","phone":"+7999123456","message":"Хочу заказать"}'
```

**Ответ:**
```json
{"status": "success", "id": "550e8400-e29b-41d4-a716-446655440000"}
```

**Уведомление в Telegram:**
```
📩 Новая заявка!

name: Иван
phone: +7999123456
message: Хочу заказать
```

### Примеры интеграции

**JavaScript (fetch):**
```javascript
fetch('https://your-api.com/api/form/submit', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    name: document.getElementById('name').value,
    email: document.getElementById('email').value,
    message: document.getElementById('message').value
  })
});
```

**HTML форма:**
```html
<form id="contactForm">
  <input type="text" name="name" placeholder="Имя" required>
  <input type="email" name="email" placeholder="Email" required>
  <textarea name="message" placeholder="Сообщение"></textarea>
  <button type="submit">Отправить</button>
</form>

const response = await fetch('http://localhost:8000/api/form/submit', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify(data)
  });

if (response.ok) {
    alert('Заявка отправлена!');
  }
});
</script>
```

## API документация

После запуска доступна интерактивная документация:
- **Swagger UI:** http://localhost:8000/docs
- **ReDoc:** http://localhost:8000/redoc

### Endpoints

| Метод | URL | Описание |
|-------|-----|----------|
| POST | `/api/form/submit` | Отправить форму |
| GET | `/health` | Проверка работоспособности |

## Конфигурация

| Переменная | Описание | Обязательно |
|------------|----------|-------------|
| `DATABASE_URL` | URL подключения к PostgreSQL | Да |
| `BOT_TOKEN` | Токен Telegram бота | Нет* |
| `ADMIN_CHAT_ID` | ID чата для уведомлений | Нет* |
| `DEBUG` | Режим отладки | Нет |
| `LOG_LEVEL` | Уровень логирования (INFO, DEBUG, ERROR) | Нет |
| `CORS_ORIGINS` | Разрешённые домены (через запятую) | Нет |

*Без `BOT_TOKEN` и `ADMIN_CHAT_ID` уведомления в Telegram отправляться не будут, но заявки будут сохраняться в базу данных.

## Разработка

### Локальный запуск

```bash
# Создать виртуальное окружение
python -m venv venv
source venv/bin/activate

# Установить зависимости
pip install -r requirements-dev.txt

# Запустить PostgreSQL (например, через Docker)
docker run -d --name postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgres:16

# Применить миграции
alembic upgrade head

# Запустить сервер
uvicorn app.main:app --reload
```

### Тестирование

```bash
# Запуск тестов
pytest

# С отчётом о покрытии
pytest --cov=app --cov-report=html
```

### Линтер

```bash
ruff check app/     # проверка
ruff format app/    # форматирование
```

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

```
app/
├── main.py           # Точка входа FastAPI
├── core/
│   ├── config.py     # Конфигурация приложения
│   └── database.py   # Подключение к БД
├── models/
│   └── submission.py # Модель данных
├── schemas/
│   └── submission.py # Схемы валидации
├── api/routes/
│   ├── form.py       # Обработка форм
│   └── health.py     # Health-check
├── services/
│   └── telegram.py   # Отправка в Telegram
└── crud/
    └── submission.py # Операции с БД
```

## Лицензия

MIT License. Используйте свободно в личных и коммерческих проектах.

---

**Вопросы и предложения?** Создайте [Issue](https://github.com/Varke/form-to-telegram/issues) в репозитории.

form-to-telegram

form-to-telegram 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

form-to-telegram

form-to-telegram 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README