Categorygithub.com/jaitl/goEnglishBot
module
2.2.0+incompatible
Repository: https://github.com/jaitl/goenglishbot.git
Documentation: pkg.go.dev

# README

goEnglishBot

Build Status Lint Status Docker

Бот для Telegram для изучения английских фраз.

Бот использует сервисы AWS:

  • Polly - для генерирования озвучки фраз
  • Translate - для автоматического перевода фраз на русский язык
  • Transcribe - для распознавания голосовых сообщений

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

  • Создайте один или несколько каталогов с фразами
  • Добавьте фразы в каталоги
  • Выполняйте упражнения с фразами для их изучения

Команды:

  • Управление каталогами (категориями)
    • /cat <name> - создает новый каталог с названием name и переключается на него
    • /cats or /cl - показывает список каталогов
    • /set <id> - переключается в каталог по id
    • /catRm <id> or /crm <id> - удаляет каталог со всеми фразами по id
    • /list <id> or /l <id> - показывает список фраз в каталоге с указанным id, но не переключается на него
  • Управление фразами
    • Для добавления новой фразы в текущий каталог, отправьте фразу боту текст фразы без команды
    • /list or /l - показывает список фраз в текущем каталоге
    • <id> (просто отправить id фразы) - получить фразу, ее перевод и озвучку по id
    • /remove <id> or /rm <id> - удалить фразу по id
    • Для проверки произношения произвольной фразы отправьте боту голосовое сообщение и он пришлет текст сказанной вами фразы
  • Упражнения
    • Карточки - бот присылает фразу или ее перевод
      • /cards - вызубрить еще неизученные фразы
    • Аудио - бот присылает аудио файл с фразой на английском
      • /puzzleAudio or /pa - подставить слова во фразу с помощью кнопок
      • /writeAudio or /wa - написать фразу на английском и отправить боту (можно писать по одному или несколько фраз, либо всю фразу целиком)
    • Перевод - бот присылает фразу на русском языке
      • /puzzleTrans or /pt - подставить слова во фразу с помощью кнопок
      • /writeTrans or /wt - написать фразу на английском и отправить боту (можно писать по одному или несколько фраз, либо всю фразу целиком)
    • Произношение - бот присылает текст и аудио файл с фразой на английском
      • /speech or /sp - отправить голосовое сообщение с произношением фразы боту
      • /skip or /sk - пропустить текущую фразу, во время упражнения
    • Все команды для запуска упражнений имеют по три варианта аргументов:
      • /комманда <id> - Запускает упражнение по одной фразе по id
      • /комманда <id0> <id1> - Запускает упражнение по диапазону фраз с id0 до id1 включительно
      • /комманда - Запускает упражнение по всем фразам в текущем каталоге
  • Системные
    • /me - ваш chat id

TODO

  • Общие
    • /version - показывает текущую версию бота
  • Когда-нибудь:
    • Алгоритм расчета прогресса изучения фраз
    • Аутентификация и инвайты

Разработка

Полезные команды

  • go get <name> - добавляет зависимость

# Packages

No description provided by the author