jazzman / odmiana Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 0.0 951 KB

An easy-to-use Telegram bot for those who are learning Polish

License: GNU General Public License v3.0

Java 15.09% Dockerfile 0.02% HTML 84.89%

java language polski telegram-bot conjugation jezyk-polski learning-polish linguistics polish-language

odmiana's Introduction

Odmiana Telegram Bot

Odmiana is an easy-to-use Telegram bot for those who are learning Polish.

It will save you from having to constantly go to different sites to find the right case or conjugation of a word. Simply send it a word and it will return all its forms. Currently, the bot only supports verbs and nouns, but I plan to add support for other parts of speech in the near future. And later, grammar cheatsheets, and possibly practical exercises to learn this beautiful language.

For example, if you send the word: "kocham", you will receive the following:

Running Locally

Pre-requisites

Make sure you have installed:

JDK 17
Gradle
Docker and Docker Compose

Setup

Ask @BotFather to create a bot for you
Save the token for accessing to Telegram HTTP API
Clone the project
Set the following environment variables:

Environment Variable	Description	Default	Example
TELEGRAM_USERNAME	Username as you told it to @BotFather	N/A	odmiana_test_753_bot
TELEGRAM_TOKEN	Token @BotFather sent to you	N/A	1234567890:AAAAAAA-TMIrr1PZPowv3hNdHkn2eEMnjq8
MONGO_HOST	MongoDB hostname	localhost	localhost
MONGO_PORT	MongoDB port to expose	27017	27017
MONGO_USERNAME	MongoDB root username	root	root
MONGO_PASSWORD	MongoDB root password	secret	secret
MONGO_DATABASE	MongoDB database name	odmiana	odmiana

Go to the infrastructure and run start the MongoDB container:

cd infrastructure
docker compose up

Run an application:

cd ..
./gradlew bootRun

Open Telegram, find your bot and start a chat. Enjoy.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

odmiana's People

Contributors

Stargazers

Watchers

odmiana's Issues

Extra characters in the output

Describe the bug
For some input, there are extra words present in the result.

To Reproduce
Steps to reproduce the behavior:

Send the word 'banan'
See the 'Biernik' case in the response.

Expected behavior
No redundant words in the response.

Screenshots

Additional context
These words and characters come from the links which are present on the page being parsed. Need to sanitize the output.

Translation Command

Create a new translate command. Which should work like the following to translate from the current language into Polish:

/translate_to_pl love

and from Polish to the current language:

/translate_from_pl miłość

Remove extra text from the translation

Sometimes the translation output contains the redundant text. For example:

Grammar cheat sheet: noun cases

Create a new high-level command for grammar cheat sheets. In the future on the second level, there should be buttons for different parts of speech.

Implement the 'Noun' button. Clicking on that button should show a list of buttons representing the noun cases:

Mianownik
Dopłniacz
...

Clicking on these buttons returns grammar rules for creating the different forms of a noun: endings, examples, etc.

Support for numerals

Add support for numerals.
Make it possible to translate numbers into words, i.e. 15 -> piętnaście + all the forms

No translation for some words

Describe the bug
For some words, there is no translation when requesting conjugation.

To Reproduce
Steps to reproduce the behavior:

Type the word 'ćwiczenie'
Click on 'Send'
See the response without a translation

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots

Send a TG message to the owner (admin) after deployments

Need an automated way to see if deployment went well or not.

Send a message to the owner (admin) of the bot with health check information after deployment is finished.

Implement a /healthcheck command.

Support for adverbs

Add support for adverbs.

Mongo illegal state

java.lang.IllegalStateException: state should be: open

Limit CI/CD actions for the new PR

Is your feature request related to a problem? Please describe.
CI/CD runs the whole flow if the pull request is created.

Describe the solution you'd like
Update CI/CD action to run only:

tests
sonarqube analysis
sonarqube quality gate check

/set_language uk