Flashy

About

Flashy is an application which can help you make and memorize flashcards. It's meant to be used as a study tool, that keeps track of all your sets of flashcards.

A more in depth description of flashy's features can be found in the user story

Previews:

Main page:

Flashy in action:

^{_{Note: these images are just a concepts, the application may look a little different at release.}}

Usage

To use the application, you can download and run the jar file found in the latest release

To run it, you're going to need do download java.

Development requirements

The easiest solution to get this running, is to open the project in Gitpod

If you want to work on it locally, you're going to need the following things:

A working installation of Maven 3
JDK 16 or higher

you can start the project by running

$ mvn javafx:run

Modules

This project is split into modules. Each module is responsible for separate parts of the application.

Module Name	Description
Core	The base classes and logic used everywhere in the application
FXUI	The desktop application
Report	A special module used to generate code coverage reports
....	(More modules are probalbly coming)

API (Coming soon)

This application also has an API, which makes it easy to extend the application to other platforms, like websites or phone apps.