Первый коммит с .gitignore

This commit is contained in:
Redsandyg
2025-06-02 13:22:06 +03:00
commit 9a3639b5ff
6 changed files with 577 additions and 0 deletions

62
README.md Normal file
View File

@@ -0,0 +1,62 @@
# Главный экран
Появляется после ввода команды /start
Текст сообщения: Официальное приветствие. Коротко описание что это бот для партнерки
Кнопки:
1. Мои ссылки — просмотр ваших партнерских ссылок с пагинацией
2. Промо материалы — переход по внешней ссылке
3. Партнерское соглашение — переход по внешней ссылке
4. Задать вопрос — всплывающее сообщение (функция не реализована)
5. Моя статистика — просмотр общей статистики и статистики по рефералам с пагинацией
6. Создать заявку на вывод средств — всплывающее сообщение (функция не реализована)
---
## Формат файлов данных
### partner-tg/my_links_mock_data.json
Массив объектов:
```
[
{
"link": "stores-apple.com?ref=<uuid>", // ссылка с уникальным идентификатором
"name": "Название ссылки" // описание/название ссылки
},
...
]
```
- `link` — уникальная партнерская ссылка
- `name` — описание/название ссылки
### partner-tg/my_ststs_mock_data.json
Объект:
```
{
"totalSales": int, // общее количество продаж
"totalIncome": float, // общий доход
"availableWithdrawal": float, // доступно к выводу
"refData": [ // список данных по рефералам
{
"name": str, // название реферальной ссылки
"sales": int, // количество продаж по ссылке
"income": float // доход по ссылке
},
...
]
}
```
- `totalSales` — общее количество продаж
- `totalIncome` — общий доход
- `availableWithdrawal` — сумма, доступная к выводу
- `refData` — массив статистики по каждой реферальной ссылке
---
## Основные функции бота
- Все экраны реализованы через редактирование исходного сообщения (edit_text), а не отправку новых сообщений.
- Для списков и таблиц реализована пагинация (по 10 элементов на страницу).
- Кнопки навигации и возврата всегда присутствуют на соответствующих экранах.
- Для не реализованных функций выводится всплывающее сообщение (show_alert).