dasbot

A Telegram bot that helps you learn German der/die/das articles

https://dasbot.yak.supplies

How to run locally

1. Clone the repo
2. Edit settings/set the env variables (see settings.toml and .env.example)
3. Create and activate a virtual environment: python3 -m venv .venv && source ./.venv/bin/activate
4. Install dependencies: pip install -r requirements.txt
5. Run make run

As an alternative,

• Run docker compose up after the first two steps

Deployment

• Run docker compose pull && docker compose up -d

Dictionary

You'll need a db collection 'dictionary_v3', see the example in /dictionary.

Notes

Spaced repetition

I've adapted a simple algorithm borrowed from drill-srs.

A correct answer increases the card's score by 1, while a mistake decreases its score by 1.

Сorner cases

• Some nouns can have different gender depending on the meaning: der See (lake) - die See (sea), der Leiter (leader) - die Leiter (ladder)
• For some nouns, more than one gender is correct, with the same meaning (der/das Teil)
• Sometimes gender depends on the context (die/der Jugendliche, Beschäftigte, Erwachsene, Geliebte)
• ... what else?

Todo

• Daily quiz ✔
• Spaced repetition ✔
• Statistics ✔
• Hint: translation and/or context ✔
• Webhooks instead of long polling ✔
• Add Docker build/push actions to CI ✔
• Randomize quiz time on 1st start ✔
• Move DB to MongoDB Atlas ✔
• i18n ✔
• Revise the dictionary ✔
• Add some tools for dictionary management
• Select words by level -- A1, B1, ... ✔
• Let users add their words
• "Forget me" command ✔
• Custom quiz intervals ("N times/day every 3 hours")
• Postpone broadcast when restarting after outage (use a one-off script?)
• Hall of fame
• Auto-pause when all words are memorized