Preliminary version of features and entities model

UdL-EPS-SoftArch · Sep 29, 2024 · 4d129d5 · 4d129d5
1 parent 906843b
commit 4d129d5
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 26 deletions.
diff --git a/EntitiesModel.puml b/EntitiesModel.puml
@@ -1,15 +1,45 @@
 @startuml
 
 class User extends UriEntity implements UserDetails {
-  username : String
-  password : String
-  email : String
+    username : String
+    password : String
+    email : String
 }
 
 class UriEntity {
-  uri : String
+    uri : String
 }
 
-User "1" --right-- "*" Resource : owner <
+class Admin extends User {}
+class Student extends User {}
+class Owner extends User {}
+
+class Property extends UriEntity {
+    description : String
+}
+
+class Apartment extends Property {
+    street : String
+    number : String
+    city : String
+}
+Owner "1" --up-- "*" Apartment : owner <
+
+class Room extends Property {
+}
+Apartment "1" --left-- "*" 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 <
 
 @enduml
diff --git a/README.md b/README.md
@@ -2,10 +2,10 @@
 
 Spring Boot project including Spring REST, HATEOAS, JPA, etc. Additional details: [HELP.md](HELP.md)
 
-[![Open Issues](https://img.shields.io/github/issues-raw/UdL-EPS-SoftArch/myapartments-api?logo=github)](https://github.com/orgs/UdL-EPS-SoftArch/projects/12)
+[![Open Issues](https://img.shields.io/github/issues-raw/UdL-EPS-SoftArch/myapartments-api?logo=github)](https://github.com/orgs/UdL-EPS-SoftArch/projects/22)
 [![CI/CD](https://github.com/UdL-EPS-SoftArch/myapartments-api/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/UdL-EPS-SoftArch/myapartments-api/actions)
 [![CucumberReports: UdL-EPS-SoftArch](https://messages.cucumber.io/api/report-collections/faed8ca5-e474-4a1a-a72a-b8e2a2cd69f0/badge)](https://reports.cucumber.io/report-collections/faed8ca5-e474-4a1a-a72a-b8e2a2cd69f0)
-[![Deployment status](https://img.shields.io/uptimerobot/status/m792691238-18db2a43adf8d8ded474f885)](https://myapartments-api.fly.dev/users)
+[![Deployment status](https://img.shields.io/uptimerobot/status/m795321927-f749cb61c053b61e8da643c3)](https://myapartments-api.fly.dev)
 
 ## Vision
 
@@ -16,14 +16,15 @@ Spring Boot project including Spring REST, HATEOAS, JPA, etc. Additional details
 
 ## Features per Stakeholder
 
-| USER                | ADMIN                |
-|---------------------|----------------------|
-| Register            |                      |
-| Login               |                      |
-| Logout              |                      |
-|                     |                      |
+| USER             | ADMIN | STUDENT             | OWNER                          |
+|------------------|-------|---------------------|--------------------------------|
+| Register Student |       | List Advertisements | Register Apartment (and rooms) |
+| Register Owner   |       | Find Advertisement  | Publish Advertisement          |
+| Login            |       | Request Visit       | List Owned Apartments          |
+| Logout           |       |                     | List Own Advertisements        |
+|                  |       |                     | Accept Visit                   |
+|                  |       |                     | Reject Visit                   |
 
 ## Entities Model
 
-![EntityModelsDiagram](http://www.plantuml.com/plantuml/svg/5Sqn3W8X40NGtbFe0M1wgxNOJXEJZGT061SI6CZC9rvVjthbMmn1CLizNOh4EXDFhUSC3BiIQVZwlI3FzpJMs0KiyB4tUgMxMv-Rs_e7DusPR6YHtO7Rg05CBHXOQHKK5BP7JrpzEAA59Vtz0G00?v0)
-
+![EntityModelsDiagram](https://www.plantuml.com/plantuml/svg/5Sqn3i8m30NGdLF00LhlJ6Ne1X9InG5Cuf98YHFPFqBS7fZU-1O76qOjXrFMK4QKOmAwducCt_Ch8utdSB7G5AAOGwlqYDTflM_JrdPSB2Ig7-vigABmYNicazqf2KUdobbfLMHayLkBKkR-_nRH-FCB?v0)
diff --git a/fly.toml b/fly.toml
@@ -12,7 +12,7 @@ swap_size_mb = 512
 [http_service]
   internal_port = 8080
   force_https = true
-  auto_stop_machines = true
+  auto_stop_machines = 'stop'
   auto_start_machines = true
   min_machines_running = 0
   processes = ['app']
@@ -21,16 +21,14 @@ swap_size_mb = 512
   protocol = 'tcp'
   internal_port = 8080
 
-[[services.ports]]
-  port = 80
-  handlers = ['http']
-  force_https = true
+  [[services.ports]]
+    port = 80
+    handlers = ['http']
+    force_https = true
 
-[[services.ports]]
-  port = 443
-  handlers = ['tls', 'http']
+  [[services.ports]]
+    port = 443
+    handlers = ['tls', 'http']
 
 [[vm]]
-  cpu_kind = 'shared'
-  cpus = 1
-  memory_mb = 256
+  size = 'shared-cpu-1x'