## Overview

Repository containing implementation for flashcard-based applications.

### Set up

- Need to have `python3.12` preinstalled
- Run `./bootstrap-venv.sh` to create the environment and install the packages
- Need to have flashcard files (can clone the schwiizertuutsch repo for this): `git clone git.0xf7.com:schwiizertuutsch`

### Run applications

#### Running cli-based flashcards

Call `./venv/bin/python cli-project/flashcard_cli.py practice <STATE_FILE> <PATHS_TO_FLASHCARDS>` to start practicing

> STATE_FILE - is a txt file where the progression state is kept - for a more efficient learning with the flashcards, based on how often you got them right or wrong

>  PATH_TO_FLASHCARDS - paths to the `.fcard` files containing the flashcards contents


#### Running GUI application

To run the GUI application, you need to update paths in `gui-project/main_ui.py`:
 - `FLASHCARDS_ROOT` = path to folder containing `.fcard` files
 - `STATE_FILE` = path to file for storing and using the state

 Then run:
 `./venv/bin/python gui-project/main.py`