From bdf4961ea7aeb46c65bf2168c39dd69b1aff4f6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roberto=20Garc=C3=ADa?= Date: Sun, 13 Oct 2024 12:30:57 +0200 Subject: [PATCH] Switch from PlantUML to Mermaid --- EntitiesModel.puml | 64 --------------------------------------- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 74 insertions(+), 65 deletions(-) delete mode 100644 EntitiesModel.puml diff --git a/EntitiesModel.puml b/EntitiesModel.puml deleted file mode 100644 index 0d120e7..0000000 --- a/EntitiesModel.puml +++ /dev/null @@ -1,64 +0,0 @@ -@startuml - -class UriEntity { - uri : String -} - -class Property extends UriEntity { - description : String -} - -class ApartmentDetails extends UriEntity{ - square : Float - numBathrooms : Integer - numBedrooms : Integer - hasAC : Boolean - hasElevator : Boolean -} - -class Apartment extends Property { - street : String - number : String - city : String -} -Owner "1" --up-- "*" Apartment : owner < -Apartment "1" --down-- "1" ApartmentDetails : details < - -class Room extends Property { -} -Apartment "1" --right-- "*" Room : in < - -class Advertisement extends UriEntity { - title : String - description : String - price : Double -} -Property "1" --right-- "*" Advertisement : about < - -class Visit extends UriEntity { - when : ZonedDateTime -} -Advertisement "1" --right-- "*" Visit : for < -Student "1" --left-- "*" Visit : visitor < - -class Review extends UriEntity { - title : String - description : String - rating : Double -} -Advertisement "1" --down-- "*" Review : about < - -class User extends UriEntity implements UserDetails { - username : String - password : String - email : String -} - -class Admin extends User {} -class Student extends User { - phoneNumber : String - name : String -} -class Owner extends User {} - -@enduml diff --git a/README.md b/README.md index bff0449..6cc3d59 100644 --- a/README.md +++ b/README.md @@ -28,4 +28,77 @@ Spring Boot project including Spring REST, HATEOAS, JPA, etc. Additional details ## Entities Model -![EntityModelsDiagram](https://www.plantuml.com/plantuml/svg/5OuxheCm403xTugN0u23mNnIaO8kaIAX7C3iBi4I_iXUAyhjGwffHgCP4-l8sUv_9-DWpqZ_6tD85o6YVfSlmrjUSg88tZ4vBi5RySHRCJtcOlOhNoDimdvqE3Bs45AXWn5QGrUrjLgmmGQgOP1we0PwTLxxLKhLAPHTtTPYScpOKBfxfBqClv6H71xy0W00) +```mermaid +classDiagram + +class UriEntity { + String uri +} +UriEntity <|-- Property +UriEntity <|-- ApartmentDetails +UriEntity <|-- Advertisement +UriEntity <|-- Visit +UriEntity <|-- Review +UriEntity <|-- User + +class UserDetails { <> } + +class User { + String username + String password + String email +} +UserDetails <|.. User +User <|-- Admin +User <|-- Student +User <|-- Owner + +class Student { + String phoneNumber + String name +} + +class Property { + String description +} +Property <|-- Apartment +Property <|-- Room + +class Apartment { + String street + String number + String city +} +Owner "1" --> "*" Apartment : owner +Apartment "1" <-- "1" ApartmentDetails : details +Apartment "1" <-- "*" Room : in + +class ApartmentDetails { + Float square + Integer numBathrooms + Integer numBedrooms + Boolean hasAC + Boolean hasElevator +} + +class Advertisement { + String title + String description + Double price +} +Property "1" <-- "*" Advertisement : about + +class Visit { + ZonedDateTime when +} +Advertisement "1" <-- "*" Visit : for +Student "1" <-- "*" Visit : visitor + +class Review { + String title + String description + Double rating +} +Advertisement "1" <-- "*" Review : about + +```