Skip to content

lucabindini/study_and_repeat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Study and Repeat

Study and Repeat is an application that aims to integrate the spaced repetition technique into your study method. Through it, a student or any person wishing to learn a certain topic can do it in a simple and intuitive way, optimizing time and avoiding long study sessions in the last days before the exam. The entire development phase of the application and other information about it are available in the paper.

Usage

Download the file for your operating system from latest release. Alternatively, if you want to build the application on your own, follow the instructions in the Build section.

Requirements

These are the requirements in case you want to build the application, they are not needed in case you just want to run the release.

program GNU/Linux Windows macOS
python required required required
make recommended recommended recommended
git recommended recommended recommended
zip preinstalled not required recommended

Build

Clone the repository in a directory of your choice:

git clone https://github.com/lucabindini/study_and_repeat 

Open study_and_repeat project folder:

cd study_and_repeat

Create and activate a virtual environment (this step is optional and can be done in many different ways, e. g. you might want to use conda). On Unix-like systems, you could do it like this:

python3 -m venv env
. env/bin/activate

On Windows PowerShell, you could do it like this:

python -m venv env
.\env\Scripts\Activate.ps1

Install the library and icons dependencies:

make install

Build the application, the output will be in dist:

make

Functionalities

Below is a list of all the functionalities of the application:

  • Create deck in your local machine with the possibility to edit it whenever you want.
  • Add card to a desired deck. Cards can have an answer not only formed by text but enriched by images.
  • Move card inside his deck.
  • Remove card if it's incorrect or no longer needed.
  • Rename deck if it has incorrect or outdated name.
  • Delete deck if it's no longer needed.
  • Reset deck if you want to clear spaced repetition temporal statistics.
  • Export deck in a .tar archive file. During the export phase you can choose whether or not to enter the temporal information of the spaced repetition technique.
  • Import deck from a .tar deck file previously exported.
  • View statistics in particular the number of new cards (never studied) and the number of cards to be reviewed today

GUI

The application is divided into 3 main screens.

  • Home that is the main screen of the application.

  • Edit deck that is the screen where you can edit a certain deck.

  • Study deck that is the screen where you can study a certain deck.

Authors

License

Licensed under the term of GNU GPL v3.0.