Feature/report

.gitignore

@@ -4,6 +4,7 @@ __pycache__
 
 *:Zone.Identifier
 
+
 # C extensions
 *.so
 

Livrable/README.md

@@ -0,0 +1,6 @@
+# Livrables
+
+Générer un pdf à partir de .md (Markdown):
+sudo apt install texlive-latex-recommended texlive-fonts-recommended
+sudo apt install pandoc
+pandoc [nom du fichier markdown].md -o [nom du fichier pdf à générer].pdf --toc -V geometry:margin=1in

diagrams/auth-diagram.puml → Livrable/diagrams/auth-diagram.puml

@@ -1,6 +1,10 @@
 @startuml
-title "Sequencial Diagram \n Authentification"
-
+title Sequencial Diagram\nAuthentification
+scale 0.5
+skinparam monochrome true
+skinparam shadowing false
+skinparam defaultFontName Arial
+skinparam linetype ortho
 skinparam style strictuml
 skinparam sequenceMessageAlign center
 

Livrable/diagrams/db-diagram.puml

@@ -0,0 +1,140 @@
+@startuml
+title UML Diagram\nDatabase Printech
+scale 1.4
+hide circle
+skinparam linetype ortho
+skinparam shadowing false
+skinparam roundcorner 10
+skinparam nodesep 80
+skinparam ranksep 80
+skinparam monochrome true
+skinparam backgroundColor white
+skinparam defaultFontName Segoe UI, Arial, sans-serif
+skinparam style strictuml
+
+package "User Environment" #DDDDDD {
+
+    enum UserRole <<enumeration>> {
+        ADHERENT
+        ROBOTECH
+        AUTOTECH
+        DRONE
+        BUREAU
+    }
+
+    enum RequestStatus <<enumeration>> {
+        SUBMITTED
+        AWAITING_PAYMENT
+        PENDING
+        PRINTING
+        AWAITING_PICKUP
+        PICKED_UP
+        FAILED
+        CANCELED
+    }
+
+    enum OperationType <<enumeration>> {
+        CASH
+        CARD
+        PAYMENT
+        REFUND
+    }
+
+    entity "User" as user {
+        *id : UUID <<PK>>
+        --
+        *username : varchar(150) <<UNIQUE>>
+        *email : varchar(254) <<UNIQUE>>
+        credit : integer = 0
+        role : UserRole = ADHERENT
+        profile_picture : varchar(100)
+    }
+
+    entity "File" as file {
+        *id : UUID <<PK>>
+        --
+        filament_id : Bigint <<FK>>
+        *path : varchar(100)
+        number_of_printing : integer = 1 {>= 0}
+        para_slicer : jsonb
+    }
+
+    entity "Request" as request {
+        *id : UUID <<PK>>
+        --
+        *user_id : UUID <<FK>>
+        file_id : UUID <<FK>>
+        printer_id : varchar(25) <<FK>>
+        price : integer = 0 {>= 0}
+        comment : text
+        *created_at : DateTime
+        status : RequestStatus = SUBMITTED
+    }
+
+    entity "Operation" as operation {
+        *id : UUID <<PK>>
+        --
+        *beneficiary_id : UUID <<FK>>
+        *agent_id : UUID <<FK>>
+        request_id : UUID <<FK>>
+        *operation_type : OperationType
+        *amount : integer = 0
+        comment : text
+        *created_at : DateTime
+    }
+}
+
+package "Material Assets" #DDDDDD {
+    entity "Printer" as printer {
+        *name : varchar(25) <<PK>>
+        --
+        status : PrinterStatus = DOWN
+    }
+
+    entity "Filament" as filament {
+        *id : Bigint <<PK>>
+        --
+        color : varchar(7) = '#ffffff'
+        *color_name : text
+        *type : FilamentType
+        quantity : integer = 0 {>= 0}
+        price : integer = 0 {>= 0}
+    }
+
+    enum FilamentType <<enumeration>> {
+        PLA
+        PETG
+    }
+
+    enum PrinterName <<enumeration>> {
+        CREALITY_K1C
+        SNAPMAKER_U1
+        PRUSA_MK3
+    }
+
+    enum PrinterStatus <<enumeration>> {
+        UP
+        DOWN
+        USED
+    }
+}
+
+' Relationships
+user ||--o{ request : "places"
+
+user ||--o{ operation : "agent"
+
+file ||--o{ request : "is printed in"
+filament ||-r-o{ file : "used by"
+printer ||-r-o{ request : "processes"
+request ||--o{ operation : "paid/refunded by"
+
+' Enum dependencies
+user ..> UserRole : uses
+request ..> RequestStatus : uses
+operation ..> OperationType : uses
+printer .u.> PrinterStatus : uses
+printer .l.> PrinterName : uses
+filament .l.> FilamentType : uses
+
+@enduml