Resolve "Add plantUML to readme"
This commit is contained in:
Hallvard Henriksen
committed by
Øystein Martinussen
Øystein Martinussen
parent
c832aaba2e
commit
f7c73e5963
@@ -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
|
||||
+19
-10
@@ -33,6 +33,14 @@ A more in depth description of flashy's features can be found in the **[user sto
|
||||
|
||||
<sup><sub>Note: these images are just a concepts, the application may look a little different at release.</sub></sup>
|
||||
|
||||
### Architecture
|
||||
|
||||
<div align="center">
|
||||
<img src="../graphics/architecture.png" alt="Structure diagram" />
|
||||
</div>
|
||||
|
||||
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
|
||||
[module-packaging]: ./packaging
|
||||
@@ -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
|
||||
+3
-1
@@ -13,12 +13,14 @@
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<maven.compiler.source>16</maven.compiler.source>
|
||||
<maven.compiler.target>11</maven.compiler.target>
|
||||
<gitlab.url>https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141</gitlab.url>
|
||||
<gitlab.url>https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141</gitlab.url>
|
||||
|
||||
<!-- Dependency versions -->
|
||||
<openjfx.version>18-ea+2</openjfx.version>
|
||||
<junit.version>5.8.0</junit.version>
|
||||
<testfx.version>4.0.16-alpha</testfx.version>
|
||||
<mockito.version>4.0.0</mockito.version>
|
||||
|
||||
</properties>
|
||||
|
||||
<scm>
|
||||
|
||||
@@ -6,8 +6,8 @@
|
||||
|
||||
<bannerLeft>
|
||||
<name>${project.name}</name>
|
||||
<src>https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141/-/raw/master/graphics/logo_with_word_96.png</src>
|
||||
<href>https://gitlab.stud.idi.ntnu.no/it1901/groups2021/gr2141/gr2141</href>
|
||||
<src>https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141/-/raw/master/graphics/logo_with_word_96.png</src>
|
||||
<href>https://gitlab.stud.idi.ntnu.no/it1901/groups-2021/gr2141/gr2141</href>
|
||||
</bannerLeft>
|
||||
|
||||
<skin>
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 98 KiB |
Reference in New Issue
Block a user