diff --git a/README.md b/README.md index 4de5c38..c2e762b 100644 --- a/README.md +++ b/README.md @@ -18,18 +18,18 @@ The project reports are available in the sidebar of the [project page][project-p Check other reports like code coverage, code quality and test reports from the [project page][project-page], or click one of the ![badges][badge-example] at the top of the file. -[badge-pipeline]: https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141/badges/master/pipeline.svg -[badge-coverage]: https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141/badges/master/coverage.svg? +[badge-pipeline]: https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141/badges/master/pipeline.svg +[badge-coverage]: https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141/badges/master/coverage.svg? [badge-projectpage]: https://img.shields.io/badge/Docs-Project%20Page-blue [badge-download]: https://img.shields.io/badge/Download-JAR-purple [badge-gitpod]: https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod -[pipeline]: https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141/-/pipelines -[code-coverage]: https://it1901.pages.stud.idi.ntnu.no/groups2021/gr2141/gr2141/jacoco-aggregate/index.html -[project-page]: https://it1901.pages.stud.idi.ntnu.no/groups2021/gr2141/gr2141/index.html -[download]: https://it1901.pages.stud.idi.ntnu.no/groups2021/gr2141/gr2141/flashy.jar -[gitpod]: https://gitpod.stud.ntnu.no/#https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141 +[pipeline]: https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141/-/pipelines +[code-coverage]: https://it1901.pages.stud.idi.ntnu.no/groups-2021/gr2141/gr2141/jacoco-aggregate/index.html +[project-page]: https://it1901.pages.stud.idi.ntnu.no/groups-2021/gr2141/gr2141/index.html +[download]: https://it1901.pages.stud.idi.ntnu.no/groups-2021/gr2141/gr2141/flashy.jar +[gitpod]: https://gitpod.stud.ntnu.no/#https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141 -[releases]: https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141/-/releases -[project-page]: https://it1901.pages.stud.idi.ntnu.no/groups2021/gr2141/gr2141/index.html +[releases]: https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141/-/releases +[project-page]: https://it1901.pages.stud.idi.ntnu.no/groups-2021/gr2141/gr2141/index.html [badge-example]: https://img.shields.io/badge/badges-blue \ No newline at end of file diff --git a/flashy/README.md b/flashy/README.md index 5d3ed09..94b7c42 100644 --- a/flashy/README.md +++ b/flashy/README.md @@ -33,6 +33,14 @@ A more in depth description of flashy's features can be found in the **[user sto Note: these images are just a concepts, the application may look a little different at release. +### Architecture + +
+ Structure diagram +
+ +Link to Architecture.wsd is found here: [architecture](architecture.puml) + ## Usage To use the application, you can download and run the jar file found in the **[latest release][latest-release]**. @@ -80,31 +88,32 @@ This project is split into modules. Each module is responsible for separate part | [FXUI][module-fxui] | The desktop application | | [Report][module-report] | A special module used to generate code coverage reports | | [Packaging][module-packaging] | A special module used to package the code into a runnable JAR | -| .... | (More modules are probalbly coming) | +| .... | (More modules are probably 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. -[badge-pipeline]: https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141/badges/master/pipeline.svg -[badge-coverage]: https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141/badges/master/coverage.svg? +[badge-pipeline]: https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141/badges/master/pipeline.svg +[badge-coverage]: https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141/badges/master/coverage.svg? [badge-projectpage]: https://img.shields.io/badge/Docs-Project%20Page-blue [badge-download]: https://img.shields.io/badge/Download-JAR-purple [badge-gitpod]: https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod -[pipeline]: https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141/-/pipelines -[code-coverage]: https://it1901.pages.stud.idi.ntnu.no/groups2021/gr2141/gr2141/jacoco-aggregate/index.html -[project-page]: https://it1901.pages.stud.idi.ntnu.no/groups2021/gr2141/gr2141/index.html -[download]: https://it1901.pages.stud.idi.ntnu.no/groups2021/gr2141/gr2141/flashy.jar -[gitpod]: https://gitpod.stud.ntnu.no/#https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141 +[pipeline]: https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141/-/pipelines +[code-coverage]: https://it1901.pages.stud.idi.ntnu.no/groups-2021/gr2141/gr2141/jacoco-aggregate/index.html +[project-page]: https://it1901.pages.stud.idi.ntnu.no/groups-2021/gr2141/gr2141/index.html +[download]: https://it1901.pages.stud.idi.ntnu.no/groups-2021/gr2141/gr2141/flashy.jar +[gitpod]: https://gitpod.stud.ntnu.no/#https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141 +[arc]: /flashy/architecture.wsd [java-download]: https://www.java.com/en/download/ -[latest-release]: https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141/-/releases/latest +[latest-release]: https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141/-/releases [install-maven]: https://maven.apache.org/download.cgi [install-openjdk]: https://jdk.java.net/16/ [module-core]: ./core [module-fxui]: ./fxui [module-report]: ./report -[module-report]: ./packaging \ No newline at end of file +[module-packaging]: ./packaging \ No newline at end of file diff --git a/flashy/architecture.puml b/flashy/architecture.puml new file mode 100644 index 0000000..b871da9 --- /dev/null +++ b/flashy/architecture.puml @@ -0,0 +1,51 @@ +@startuml +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 + + package it1901.groups2021.gr2141.core.state as state +} + +component fxui{ + package it1901.groups2021.gr2141.ui as ui + + package it1901.groups2021.gr2141.ui.controllers as controllers +} + +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 +core --> jackson +ui --> state +ui --> domain +ui <--> controllers +controllers --> models +domain --> models +domain --> state + +controllers --> domain +serializer --> models +storage --> serializer +storage --> models +ui --> models +ui --> storage +@enduml \ No newline at end of file diff --git a/flashy/pom.xml b/flashy/pom.xml index 0a0f869..832c099 100644 --- a/flashy/pom.xml +++ b/flashy/pom.xml @@ -13,12 +13,14 @@ UTF-8 16 11 - https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141 + https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141 + 18-ea+2 5.8.0 4.0.16-alpha 4.0.0 + diff --git a/flashy/src/site/site.xml b/flashy/src/site/site.xml index 88947c0..4098609 100644 --- a/flashy/src/site/site.xml +++ b/flashy/src/site/site.xml @@ -6,8 +6,8 @@ ${project.name} - https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141/-/raw/master/graphics/logo_with_word_96.png - https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141 + https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141/-/raw/master/graphics/logo_with_word_96.png + https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141 diff --git a/gr2141/docs/.gitkeep b/gr2141/docs/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/graphics/architecture.png b/graphics/architecture.png new file mode 100644 index 0000000..57e529e Binary files /dev/null and b/graphics/architecture.png differ