Squashed commit of the following:

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
This commit is contained in:
2021-11-28 23:28:46 +01:00
parent 291114ba43
commit 45972049f9
7 changed files with 102 additions and 12 deletions

View File

@@ -25,13 +25,30 @@ A more in depth description of flashy's features can be found in the **[user sto
### Architecture
#### Package diagram
<div align="center">
<img src="../graphics/architecture.png" alt="Structure diagram" />
</div>
Link to Architecture.wsd is found here: [architecture](architecture.puml)
## Download
#### Sequence diagram
<div align="center">
<img src="../graphics/sequencediagram.png" alt="Sequence diagram" />
</div>
Link to sequencediagram.wsd is found here: [sequencediagram](sequencediagram.puml)
#### Class diagram
<div align="center">
<img src="../graphics/classdiagram.png" alt="Classdiagram diagram" />
</div>
Link to classdiagram.wsd is found here: [classdiagram](classdiagram.puml)
## Usage
To use the application, you can download and run the jar file found in the **[latest release][latest-release]**.

View File

@@ -2,8 +2,6 @@
component core{
package it1901.groups2021.gr2141.core.models as models
package it1901.groups2021.gr2141.core.models.serializers as serializer
package it1901.groups2021.gr2141.core.storage as storage
package it1901.groups2021.gr2141.core.domainlogic as domain
@@ -11,6 +9,12 @@ component core{
package it1901.groups2021.gr2141.core.state as state
}
component rest{
package it1901.groups2021.gr2141.rest.restapi as restapi
package it1901.groups2021.gr2141.rest.restserver as restserver
}
component fxui{
package it1901.groups2021.gr2141.ui as ui
@@ -20,20 +24,14 @@ component fxui{
component packaging{
package it1901.groups2021.gr2141
}
component javafx {
}
component jackson{
}
component material_icons {
}
fxui -[hidden]d--> core
fxui --> javafx
fxui --> core
fxui --> material_icons
packaging --> javafx
packaging --> fxui
fxui --> material_icons
core --> jackson
ui --> state
ui --> domain
@@ -42,10 +40,19 @@ controllers --> models
domain --> models
domain --> state
component javafx {
}
component jackson{
}
component material_icons {
}
controllers --> domain
serializer --> models
storage --> serializer
storage --> models
ui --> models
ui --> storage
storage --> restserver
storage --> restapi
@enduml

53
flashy/classdiagram.puml Normal file
View File

@@ -0,0 +1,53 @@
@startuml
CardDeck <|-- Flashcard
class CardDeck{
- Flashcards : List<flashcard>
+ add(flashcard)
+ add(index, flashcard)
+ remove(index)
+ isEmpty() : boolean
+ getNumberOfCards() : int
}
CardDeck <|-- FlashcardProvider
Flashcard <|-- FlashcardProvider
class FlashcardProvider {
- deck : cardDeck
- cardIndex : int
- cardShowsFront : boolean
- showOrderIsFlippedMode : boolean
- cardOrderIsRandomMode : boolean
- firstLastWrapAroundMode : boolean
+ setCardDeckStorage(CardDeckStorage)
+ initializeCardDeck()
+ initializeModes()
}
class Flashcard {
- front : CardContent
- back : CardContent
+ getFront() : front
+ getBack() : back
+ setFront(front)
+ setBack(back)
}
Flashcard <|-- CardContent
class CardContent{
- lines : List<String>
+ getLines() : lines
}
CardDeckStorage <|-- FlashcardProvider
Interface CardDeckStorage {
+ LocalCardDeckStorage
+ RemoteCardDeckStorage
+ writeDeck(id)
+ readDeck(id) : CardDeck
+ readAllDecks() : List<CardDeck>
}
@enduml

View File

@@ -0,0 +1,13 @@
@startuml
actor User
User -> "~#Writefront & Writeback: TextField" : write term and definition
User -> "~#Add Card: Button" as newTodoItemButton: click
newTodoItemButton -> MenuController : handleCreateFlashCard
MenuController -> FlashcardProvider: getCardDeck
FlashcardProvider -> CardDeck: add
MenuController-> "~#Writefront & Writeback: TextField" : getText
CardDeck-> FlashcardProvider : updateSubscribers
FlashcardProvider -> CardDeckStorage: writeDeck
CardDeckStorage -> "REST-API": POST
MenuController-> "~#Writefront & Writeback: TextField" : clearText
@enduml

Binary file not shown.

Before

Width:  |  Height:  |  Size: 98 KiB

After

Width:  |  Height:  |  Size: 185 KiB

BIN
graphics/classdiagram.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 183 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 108 KiB