Bot document

Introduction

A telegramBot you can make your own dictionary in order to train your memory.

[TOC]

Functions

• /save
  type a word once and then meanings or synonyms multiple times until typing /done
  Uncategorized words will be saved in default list.

• /delete + /word +/done
  delete a saved word

• /delete + /word (shows list of meanings in order by number) +/number (multiple times until /done)
  delete linked data

• /showlist
  show all category list of words then choose one by typing the number of it /list+number
  make list by /newlist, delete by /deletelist + number
  add word in the list by /list+number + /save +word (first)+ related data (multiple)+/done

• Game
  A card game which you have to write the word that mach to the random shown data from chosen list. infinite time

• /game (shows lists) + /list+number + /start
  Start game
  +/end to exit game -> shows result correct/total (times)

dfdf

Functions I need (Nikitos)

• I want the bot to save new words
• Persistant store
• Web interface for easier database managment
• Conference mode (bot in a conference). Collaborative usage
• Private chat mode (tet-a-ter messaging).
• All the events generated by a user are saved in the database for further usage and analysis
• Hashtags as categories
• Bot must support messages edits. (If I edit a word card. It should update its database record)
• Simple new words cards syntax.

Other possible features (Nikitos)

• Export to Notion.so table
• https://context.reverso.net/ support

Grammar is

word
#tag1 #tag2
#tag3

/transcription/

= meaning 1
- example sentance 1

= meaning 2
- example for the meaning 2 sentance 1
- example for the meaning 2 sentance 2

Example:

diligence
#noun #gaming

/ˈdɪlɪdʒ(ə)ns/

= careful and persistent work or effort.

- The new guy is very creative but I think he needs to develop the virtue of diligence
- few party members challenge his diligence as an MP

transcription is optional. order of data is arbitrary

So the Word interface

interface Word {
    word: str
    transcription: Option[str]
    tags: List[str]
    meanings: List[Meaning]
}

Functions I need (Yaejin)

• load a list of words from Dictionary website (crawling)
• share a private list with friends.
• make a common list in a groupchat.
• in web app you can listen pronounciation via google trans API
• random words push message with time setting option.

Skill stack

• Server
• Client
• Web App
• DB