Initial commit

README.md

@@ -0,0 +1,73 @@
+# Telegram Бот для Проекта SRSP
+
+Телеграм-бот для предоставления информации о команде разработчиков, документации и презентации проекта.
+
+## Описание
+
+Этот бот предоставляет удобный интерфейс для доступа к информации о команде разработчиков, технической документации и презентации проекта. Бот разработан с использованием библиотеки aiogram 3.x.
+
+## Функциональность
+
+- `/start` - Начать работу с ботом и отобразить основную клавиатуру.
+- В ответном сообщение отправляется случайный анекдот с сайта nekdo.ru
+- `/team_members` - Показать информацию о членах команды разработчиков
+- `/documentation` - Скачать техническую документацию проекта
+- `/presentation` - Скачать презентацию проекта
+- `/help` - Показать список доступных команд
+
+## Установка и запуск
+
+### Предварительные требования
+
+- Python 3.8 или выше
+- pip (менеджер пакетов Python)
+
+### Шаги по установке
+
+1. Клонировать репозиторий:
+```bash
+git clone https://github.com/ArtzSU/SRSP-bot
+cd tgbotsrsp
+```
+
+2. Создать и активировать виртуальное окружение:
+```bash
+python -m venv .venv
+# Для Windows
+.venv\Scripts\activate
+# Для macOS/Linux
+source .venv/bin/activate
+```
+
+3. Установить зависимости:
+```bash
+pip install -r requirements.txt
+```
+
+4. Создать файл `.env` в корневой директории проекта и добавить токен бота:
+```
+BOT_TOKEN=ваш_токен_бота
+```
+
+### Запуск бота
+
+```bash
+python main.py
+```
+
+## Структура проекта
+
+- `main.py` - Основной файл с логикой бота
+- `config.py` - Конфигурационный файл с константами и настройками
+- `keyboard.py` - Файл с определениями клавиатур для бота
+- `assets/` - Директория с ресурсами (документация, презентация)
+-  `Modules/` - Директория с модулями
+-  `Modules/getAnecdote.py` - Модуль запроса случайного анекдота
+- `requirements.txt` - Список зависимостей проекта
+
+## Команда разработчиков
+
+- Лукьянов Е. - @artzsu
+- Серик Т. - @tam_serik
+- Скрипченко В. - @Sunny_Vls
+- Исламберди А. - @Y191900