Shield:

This work is licensed under a Creative Commons Attribution 4.0 International License.

Connected links

• Mindmap - GitMind
• Database design - DrawSQL
• Color palette - Atmos
• UI design - Marvel

Installation

Choose folder on your computer, where you want to have this repository. The use next command to clone it:

git clone https://github.com/ruslkhay/ReaBooKivyMD.git

Install PDM package manager and run:

curl -sSL https://pdm-project.org/install-pdm.py | python3 -
pdm install

In order to run formatting and linting manually use one of the following commands:

pre-commit run --files file.py
pre-commit run --all-files

Overview

This is a cross-platform app for studying foreign words. Main goal for this version of project is a basic application, where user can generally do two things:

• Swipe cards to segregate them into learned and unlearned piles
• Manage cards dictionary: add, delete, amend cards.

Future version features are already considered.

🚪 Main window

It's a blank welcome screen, from which user can start learning cards. In future it would be nice to have user's progress here in some way.

🧑‍💻 Study window

Here all words from cardset are shown. By tapping on card user can see meaning (translation) of the word. Right button mark word as learned and remove card from pile. Left button put card on piles bottom.

📝 Dictionary window

This screen provide options for viewing all added cards. User can add new ones, delete and amending old ones, searching cards by patterns.