h7x4
45972049f9
commit 5bf6b2bcd6110671b1e56269ef9daffd966c4073 Author: h7x4 <h7x4abk3g@protonmail.com> Date: Sun Nov 28 23:27:07 2021 +0100 Rewrite history commit a52559e4e20b476d6bb9f616c3b0ce1d5112d115 Author: Hanne Fyrand <hannelf@stud.ntnu.no> Date: Sat Nov 27 17:20:19 2021 +0100 resolve conflict commit 250a21e0a8875e215ca0213f882fb531bb1be6ca Author: Hanne Fyrand <hannelf@stud.ntnu.no> Date: Sat Nov 27 17:14:01 2021 +0100 Updated architecture commit 9562f995728c0200fac2f0d4172598fc7533500f Author: Hanne Lindbäck Fyrand <hannelf@stud.ntnu.no> Date: Sat Nov 27 17:09:22 2021 +0100 Upload New File commit 471f508b4e0eae479e4fda136eb6f6cd2d95b16d Author: Hanne Lindbäck Fyrand <hannelf@stud.ntnu.no> Date: Sat Nov 27 17:07:27 2021 +0100 Upload New File commit 9fe820bfe244eb801aa98e04c8ae897214daadb7 Author: Hanne Lindbäck Fyrand <hannelf@stud.ntnu.no> Date: Sat Nov 27 17:06:41 2021 +0100 Upload New File commit 1da42c39533af5d8384bd78c0315ad612358f589 Author: Hanne Fyrand <hannelf@stud.ntnu.no> Date: Sat Nov 27 17:08:03 2021 +0100 removed old diagram commit ff5b077d6760c23a710d3795524f0cd05174e300 Author: Hanne Fyrand <hannelf@stud.ntnu.no> Date: Thu Nov 25 11:07:38 2021 +0100 added class diagram and squence diagram commit 217bb4938668d61b56d4d7818f8de4cbb6e33696 Author: Hanne Fyrand <hannelf@stud.ntnu.no> Date: Thu Nov 25 11:03:25 2021 +0100 added sequencs and class diagram
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
Preview:
Architecture
Package diagram
Link to Architecture.wsd is found here: architecture
Sequence diagram
Link to sequencediagram.wsd is found here: sequencediagram
Class diagram
Link to classdiagram.wsd is found here: classdiagram
Usage
To use the application, you can download and run the jar file found in the latest release.
You can also use the
To run it, you're going to need do download Java.
Usage
To use the application, you can open the jar file directly.
If you would rather want to open the application in remote mode, see API
Development requirements
The easiest solution to get the development environment up and running, is to open the project in Gitpod
If you want to work on it locally, you're going to need the following things:
Launch with JAR
You can start the project by running either run.bat (windows), or run.sh (mac, linux, etc...). This will compile the application into a jar-file, which will end up in target, and then execute it. After running this script once, you will also be able to launch the jar-file directly in the file explorer, or by opening a terminal in the current directory and execute this command:
$ java -jar flashy/target/flashy.jar
Launch Manually
If you want to run the application manually without creating a jar file, open a terminal in the current directory, and execute the following commands:
$ mvn install -Dmaven.test.skip=true
$ cd fxui
$ mvn javafx:run
Note: Each time you update code outside of the fxui directory, you will need to move out to the current directory and run mvn clean compile before running mvn javafx:run inside fxui again.
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 |
| REST | The REST API server |
| Report | A special module used to generate code coverage reports |
| Packaging | A special module used to package the code into a runnable JAR |
REST API
This application also has a REST API, which makes it easy to extend the application to other platforms, like websites or phone apps.
To start the REST server, you can run
$ java -jar flashy/target/flashy.jar --server
or start it manually by executing
$ mvn install -Dmaven.test.skip=true
$ cd rest
$ mvn exec:java
Then you can start the app in remote mode by running
$ java -jar flashy/target/flashy.jar --remote
For more options, see
$ java -jar flashy/target/flashy.jar --help