From 23d8ffdb1262fb0d672e42cbb89f7efb805b905d Mon Sep 17 00:00:00 2001 From: Florian Schaessens Date: Sat, 19 Oct 2024 18:40:16 +0200 Subject: [PATCH 1/7] start readme for ULM sequence, add Registration sequence --- SequenceDiagrams.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 SequenceDiagrams.md diff --git a/SequenceDiagrams.md b/SequenceDiagrams.md new file mode 100644 index 0000000..f4b2dbd --- /dev/null +++ b/SequenceDiagrams.md @@ -0,0 +1,36 @@ +# Sequence Diagrams + +## Table of Contents + +1. [Registration Sequence](#registration-sequence) +2. [Login Sequence](#login-sequence) +3. [Logout Sequence](#logout-sequence) + +--- + +## Registration Sequence + + + +[Back to Top](#table-of-contents) + +```mermaid +sequenceDiagram + participant Guest + participant Client + participant Server + participant Database + + Guest ->>+ Client: Register Form + Client ->>+ Server: formData({credentials}) + + Server ->>+ Database: findUserByEmail(credentials.email) + alt User exists + Database -->>- Server: true (User exists) + Server -->>- Client: Email already registered (Error) + else User does not exist + Database -->>+ Server: false (No user found) + Server ->>+ Database: register({credentials}) + Database -->>+ Server: confirm register + Server -->>+ Client: registration completed + end From e563acdd25f7a174ec6184ad1572a2cae0882bbc Mon Sep 17 00:00:00 2001 From: Florian Schaessens Date: Sat, 19 Oct 2024 21:45:28 +0200 Subject: [PATCH 2/7] add login & logout sequence --- SequenceDiagrams.md | 51 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/SequenceDiagrams.md b/SequenceDiagrams.md index f4b2dbd..57dc114 100644 --- a/SequenceDiagrams.md +++ b/SequenceDiagrams.md @@ -10,8 +10,6 @@ ## Registration Sequence - - [Back to Top](#table-of-contents) ```mermaid @@ -34,3 +32,52 @@ sequenceDiagram Database -->>+ Server: confirm register Server -->>+ Client: registration completed end +``` + +## Login Sequence + +[Back to Top](#table-of-contents) + +```mermaid + sequenceDiagram + participant Guest + participant Client + participant Server + participant Database + + Guest ->>+ Client: Login Form + Client ->>+ Server: formData({credentials}) + + Server ->>+ Database: findUserByEmail(credentials.email) + alt User exists + Database -->> Server: true (User exists) + Server ->>+ Database: login({credentials}) + alt Credentials matches + Database -->> Server: credentials matches + Server -->> Client: login completed + Server -->> Client: send JWT token in cookies + else Credentials dont match + Database -->> Server: invalid credentials + Server -->> Client: Invalid credentials(Error) + end + else User does not exist + Database -->> Server: false (No user found) + Server -->> Client: Account not found (Error) + end +``` + +## Logout Sequence + +[Back to Top](#table-of-contents) + +```mermaid +sequenceDiagram + participant User + participant Client + participant Server + + User ->>+ Client: Logout Request + Client ->>+ Server: logout() + Server -->> Client: Logout completed + Server -->> Client: Clear JWT token in cookies +``` \ No newline at end of file From 97bf4a54baf4763ca264308fc5e204ed4c1678e3 Mon Sep 17 00:00:00 2001 From: Florian Schaessens Date: Sun, 20 Oct 2024 17:08:58 +0200 Subject: [PATCH 3/7] add CRUD Sequence on appointments --- SequenceDiagrams.md | 178 +++++++++++++++++++++++++++++++++++++++++--- server/package.json | 4 +- 2 files changed, 170 insertions(+), 12 deletions(-) diff --git a/SequenceDiagrams.md b/SequenceDiagrams.md index 57dc114..db04d2d 100644 --- a/SequenceDiagrams.md +++ b/SequenceDiagrams.md @@ -2,10 +2,23 @@ ## Table of Contents +### Authentification + 1. [Registration Sequence](#registration-sequence) 2. [Login Sequence](#login-sequence) 3. [Logout Sequence](#logout-sequence) +### Visitor functions + +1. [Find Trainer Sequence](#find-trainer-sequence) + +### Appointment booking + +1. [Create Appointment Sequence](#create-appointment-sequence) +2. [Read Appointment Sequence](#read-appointment-sequence) +3. [Update Appointment Sequence](#update-appointment-sequence) +4. [Delete Appointment Sequence](#delete-appointment-sequence) + --- ## Registration Sequence @@ -29,8 +42,8 @@ sequenceDiagram else User does not exist Database -->>+ Server: false (No user found) Server ->>+ Database: register({credentials}) - Database -->>+ Server: confirm register - Server -->>+ Client: registration completed + Database -->>+ Server: Confirm registration + Server -->>+ Client: Registration completed end ``` @@ -39,7 +52,7 @@ sequenceDiagram [Back to Top](#table-of-contents) ```mermaid - sequenceDiagram +sequenceDiagram participant Guest participant Client participant Server @@ -52,13 +65,13 @@ sequenceDiagram alt User exists Database -->> Server: true (User exists) Server ->>+ Database: login({credentials}) - alt Credentials matches - Database -->> Server: credentials matches - Server -->> Client: login completed - Server -->> Client: send JWT token in cookies - else Credentials dont match - Database -->> Server: invalid credentials - Server -->> Client: Invalid credentials(Error) + alt Credentials match + Database -->> Server: Credentials match + Server -->> Client: Login completed + Server -->> Client: Send JWT token in cookies + else Credentials don’t match + Database -->> Server: Invalid credentials + Server -->> Client: Invalid credentials (Error) end else User does not exist Database -->> Server: false (No user found) @@ -80,4 +93,147 @@ sequenceDiagram Client ->>+ Server: logout() Server -->> Client: Logout completed Server -->> Client: Clear JWT token in cookies -``` \ No newline at end of file +``` + +--- +--- + +## Find Trainer Sequence + +[Back to Top](#table-of-contents) + +```mermaid +sequenceDiagram + participant User/Guest + participant Client + participant Server + participant Database + + User/Guest ->>+ Client: Search dog trainer request + Client ->> Client: Validate query + alt Invalid query + Client -->> User/Guest: Error: Invalid search query + else Valid query + Client ->>+ Server: search({query}) + + Server ->>+ Database: findTrainerByQuery({query}) + alt Trainers found + Database -->>+ Server: List of trainers found ([trainers]) + Server -->> Client: Return filtered trainer list + else No trainers found + Database -->>+ Server: Empty array (no trainers found) + Server -->> Client: Message: No trainers found matching the search + end + end +``` + +--- +--- + + +## Create Appointment Sequence + +[Back to Top](#table-of-contents) + +```mermaid +sequenceDiagram + participant Dog_Trainer + participant Client + participant Server + participant Database + + Dog_Trainer ->>+ Client: Selects date, time, and service + Client ->>+ Server: formData(appointment) + Server ->>+ Database: checkAvailability({date, time}) + alt Slot available + Database -->>+ Server: Slot is available + Server ->>+ Database: create({appointment}) + Database -->> Server: Appointment confirmed + Server -->> Client: Send confirmation + Client -->> Dog_Trainer: Display confirmation message + else Slot unavailable + Database -->> Server: Slot is taken + Server -->> Client: Error: Slot unavailable + Client -->> Dog_Trainer: Display error message + end +``` + + + +## Read Appointment Sequence + +[Back to Top](#table-of-contents) + +```mermaid +sequenceDiagram + participant Dog_Owner + participant Client + participant Server + participant Database + + Dog_Owner ->>+ Client: Request to view appointments + Client ->>+ Server: getAppointments(dog_trainer.id) + Server ->>+ Database: read(dog_trainer.id) + alt Appointments found + Database -->>+ Server: List of appointments found ([appointments]) + Server -->> Client: Return appointments list + else No appointments found + Database -->>+ Server: Empty array (no appointments found) + Server -->> Client: Message: No appointments available + end +``` + +## Update Appointment Sequence + +[Back to Top](#table-of-contents) + +```mermaid +sequenceDiagram + participant Dog_Trainer + participant Client + participant Server + participant Database + + Dog_Trainer ->>+ Client: Selects an appointment to update + Client ->> Client: Display current appointment details + Dog_Trainer ->> Client: Modify appointment information + Client ->>+ Server: putAppointments(appointment) + Server ->>+ Database: checkAvailability({id}) + alt Appointment found + Database -->>+ Server: Found appointment + Server ->>+ Database: update({appointment}) + Database -->> Server: Appointment updated + Server -->> Client: Send confirmation + Client -->> Dog_Trainer: Display updated appointment + else Appointment not found + Database -->> Server: Appointment not found + Server -->> Client: Error: Appointment does not exist + Client -->> Dog_Trainer: Display error message + end +``` + +## Delete Appointment Sequence + +[Back to Top](#table-of-contents) + +```mermaid +sequenceDiagram + participant Dog_Trainer + participant Client + participant Server + participant Database + + Dog_Trainer ->>+ Client: Selects an appointment to delete + Client ->> Dog_Trainer: Confirm deletion + alt Confirmation + Client ->>+ Server: deleteAppointment({appointment.id}) + Server ->>+ Database: delete({appointment.id}) + Database -->> Server: Appointment deleted + Server -->> Client: Send confirmation + Client -->> Dog_Trainer: Display success message + else Cancellation + Client -->> Dog_Trainer: Deletion canceled + end +``` + + diff --git a/server/package.json b/server/package.json index 554451b..010e550 100644 --- a/server/package.json +++ b/server/package.json @@ -5,7 +5,9 @@ "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "start": "ts-node-dev --respawn ./src/index.ts" + "start": "ts-node-dev --respawn ./src/index.ts", + "lint": "../node_modules/@biomejs/biome/bin/biome lint --write ./src", + "format": "../node_modules/@biomejs/biome/bin/biome format --write ./src" }, "keywords": [], "author": "", From 2f055e7300ce6f5640d7a72e55219cf8b21e8c3b Mon Sep 17 00:00:00 2001 From: Florence Buchelet Date: Wed, 23 Oct 2024 15:03:06 +0200 Subject: [PATCH 4/7] feedbacks on uml sequence diags --- SequenceDiagrams.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/SequenceDiagrams.md b/SequenceDiagrams.md index db04d2d..2a64eb4 100644 --- a/SequenceDiagrams.md +++ b/SequenceDiagrams.md @@ -47,6 +47,12 @@ sequenceDiagram end ``` + Retours : + - Guest et client au même niveau me semblent étrange, on a l'impression que Guest devient Client, ce ne sont pas des éléments comparables qui ne devraient donc pas se trouver côte à côte + - Rien n'est renvoyé au Guest en fin de parcours (pour les deux scénarios) + - Trop technique je pense + + ## Login Sequence [Back to Top](#table-of-contents) @@ -79,6 +85,10 @@ sequenceDiagram end ``` + Retours : + - la logique est nickel mais il reste les problèmes soulevés avant. il manque au moins un retour vers le Guest et je pense qu'il faut le représenter autrement. + - Tu as perdu les rectangles qui représentent le temps dans ce diag. + ## Logout Sequence [Back to Top](#table-of-contents) @@ -158,6 +168,10 @@ sequenceDiagram end ``` + Retours : + - Le rôle Dog_Trainer ne correspond à rien dans nos entités, il faut qu'on soit d'accord tout de suite : c'est soit trainer soit dog_trainer mais on doit garder les mêmes termes partout. Pareil pour appointment, c'est un terme qu'on utilise ? Je me souviens plus. + - pas de s à Select + ## Read Appointment Sequence From e9cb38f82990fc01aa32a3ac26c883ae05ebbee5 Mon Sep 17 00:00:00 2001 From: Florian Schaessens Date: Thu, 24 Oct 2024 15:57:16 +0200 Subject: [PATCH 5/7] convert mermaid into draw io diagrams 3/8 --- .../UML diagrams/SequenceDiagrams.md | 71 +----------------- .../UML diagrams/assets/sequences/login.svg | 3 + .../UML diagrams/assets/sequences/logout.svg | 3 + .../assets/sequences/register.svg | 3 + _ressources/UML diagrams/diagramUseCase.md | 2 +- .../UML diagrams/{image.png => useCase.png} | Bin 6 files changed, 13 insertions(+), 69 deletions(-) rename SequenceDiagrams.md => _ressources/UML diagrams/SequenceDiagrams.md (68%) create mode 100644 _ressources/UML diagrams/assets/sequences/login.svg create mode 100644 _ressources/UML diagrams/assets/sequences/logout.svg create mode 100644 _ressources/UML diagrams/assets/sequences/register.svg rename _ressources/UML diagrams/{image.png => useCase.png} (100%) diff --git a/SequenceDiagrams.md b/_ressources/UML diagrams/SequenceDiagrams.md similarity index 68% rename from SequenceDiagrams.md rename to _ressources/UML diagrams/SequenceDiagrams.md index 2a64eb4..96b52ac 100644 --- a/SequenceDiagrams.md +++ b/_ressources/UML diagrams/SequenceDiagrams.md @@ -25,85 +25,20 @@ [Back to Top](#table-of-contents) -```mermaid -sequenceDiagram - participant Guest - participant Client - participant Server - participant Database - - Guest ->>+ Client: Register Form - Client ->>+ Server: formData({credentials}) - - Server ->>+ Database: findUserByEmail(credentials.email) - alt User exists - Database -->>- Server: true (User exists) - Server -->>- Client: Email already registered (Error) - else User does not exist - Database -->>+ Server: false (No user found) - Server ->>+ Database: register({credentials}) - Database -->>+ Server: Confirm registration - Server -->>+ Client: Registration completed - end -``` - - Retours : - - Guest et client au même niveau me semblent étrange, on a l'impression que Guest devient Client, ce ne sont pas des éléments comparables qui ne devraient donc pas se trouver côte à côte - - Rien n'est renvoyé au Guest en fin de parcours (pour les deux scénarios) - - Trop technique je pense +![UML Diagram Use Case of PawPlanner](./assets/sequences/register.svg) ## Login Sequence [Back to Top](#table-of-contents) -```mermaid -sequenceDiagram - participant Guest - participant Client - participant Server - participant Database - - Guest ->>+ Client: Login Form - Client ->>+ Server: formData({credentials}) - - Server ->>+ Database: findUserByEmail(credentials.email) - alt User exists - Database -->> Server: true (User exists) - Server ->>+ Database: login({credentials}) - alt Credentials match - Database -->> Server: Credentials match - Server -->> Client: Login completed - Server -->> Client: Send JWT token in cookies - else Credentials don’t match - Database -->> Server: Invalid credentials - Server -->> Client: Invalid credentials (Error) - end - else User does not exist - Database -->> Server: false (No user found) - Server -->> Client: Account not found (Error) - end -``` - - Retours : - - la logique est nickel mais il reste les problèmes soulevés avant. il manque au moins un retour vers le Guest et je pense qu'il faut le représenter autrement. - - Tu as perdu les rectangles qui représentent le temps dans ce diag. +![UML Diagram Use Case of PawPlanner](./assets/sequences/login.svg) ## Logout Sequence [Back to Top](#table-of-contents) -```mermaid -sequenceDiagram - participant User - participant Client - participant Server - - User ->>+ Client: Logout Request - Client ->>+ Server: logout() - Server -->> Client: Logout completed - Server -->> Client: Clear JWT token in cookies -``` +![UML Diagram Use Case of PawPlanner](./assets/sequences/logout.svg) --- --- diff --git a/_ressources/UML diagrams/assets/sequences/login.svg b/_ressources/UML diagrams/assets/sequences/login.svg new file mode 100644 index 0000000..85290c1 --- /dev/null +++ b/_ressources/UML diagrams/assets/sequences/login.svg @@ -0,0 +1,3 @@ + + +
alt
alt
User
User
Web site
Web site
Login Form
Login Form
Web server
Web server
True
True
Login
Login
Database
Database
formData({credentials})
formData({credentials})
check if User already exist
check if User already exist
[ User already exist]
[ User already exist]
[ User does not exist ]
[ User does not exist ]
False
False
Account not found ( Error )
Account not found ( Error )
login({credentials})
login({credentials})
Credentials match
Credentials match
Login completed
Login completed
Send JWT token
Send JWT token \ No newline at end of file diff --git a/_ressources/UML diagrams/assets/sequences/logout.svg b/_ressources/UML diagrams/assets/sequences/logout.svg new file mode 100644 index 0000000..dd499ec --- /dev/null +++ b/_ressources/UML diagrams/assets/sequences/logout.svg @@ -0,0 +1,3 @@ + + +
Trainer/Owner
Tra...
Web site
Web site
Clear JWT token
Clear JWT token
Logout Request
Logout Request
Web server
Web server
Logout completed
Logout completed
Logout
Logout
Logout()
Logout() \ No newline at end of file diff --git a/_ressources/UML diagrams/assets/sequences/register.svg b/_ressources/UML diagrams/assets/sequences/register.svg new file mode 100644 index 0000000..8fd73bb --- /dev/null +++ b/_ressources/UML diagrams/assets/sequences/register.svg @@ -0,0 +1,3 @@ + + +
alt
alt
User
User
Web site
Web site
Register Form
Register Form
Web server
Web server
Register
Register
Database
Database
formData({credentials})
formData({credentials})
check if User already exist
check if User already exist
[ User already exist]
[ User already exist]
True
True
User already registered ( Error )
User already registered ( Error )
[ User does not exist ]
[ User does not exist ]
False
False
register({credentials})
register({credentials})
Confirm registration
Confirm registration
Registration completed
Registration completed \ No newline at end of file diff --git a/_ressources/UML diagrams/diagramUseCase.md b/_ressources/UML diagrams/diagramUseCase.md index ae6772c..a414e03 100644 --- a/_ressources/UML diagrams/diagramUseCase.md +++ b/_ressources/UML diagrams/diagramUseCase.md @@ -2,4 +2,4 @@ ##### The UML Use Case diagram for PawPlanner illustrates the interactions between trainer(s) and the app to schedule services, manage timetables, and allow owner to sign up for activities. -![UML Diagram Use Case of PawPlanner](image.png) \ No newline at end of file +![UML Diagram Use Case of PawPlanner](./useCase.png) \ No newline at end of file diff --git a/_ressources/UML diagrams/image.png b/_ressources/UML diagrams/useCase.png similarity index 100% rename from _ressources/UML diagrams/image.png rename to _ressources/UML diagrams/useCase.png From 048ccbf1c5f489f37bf8628dcfd26bde903e1986 Mon Sep 17 00:00:00 2001 From: Florian Schaessens Date: Thu, 24 Oct 2024 17:31:34 +0200 Subject: [PATCH 6/7] convert mermaid into draw io diagrams 8/8 --- _ressources/UML diagrams/SequenceDiagrams.md | 119 +----------------- .../assets/sequences/createEvent.svg | 3 + .../assets/sequences/deleteEvent.svg | 3 + .../assets/sequences/findTrainer.svg | 3 + .../sequences/readEventsByTrainerId.svg | 3 + .../assets/sequences/updateEvent.svg | 3 + 6 files changed, 21 insertions(+), 113 deletions(-) create mode 100644 _ressources/UML diagrams/assets/sequences/createEvent.svg create mode 100644 _ressources/UML diagrams/assets/sequences/deleteEvent.svg create mode 100644 _ressources/UML diagrams/assets/sequences/findTrainer.svg create mode 100644 _ressources/UML diagrams/assets/sequences/readEventsByTrainerId.svg create mode 100644 _ressources/UML diagrams/assets/sequences/updateEvent.svg diff --git a/_ressources/UML diagrams/SequenceDiagrams.md b/_ressources/UML diagrams/SequenceDiagrams.md index 96b52ac..bdb732d 100644 --- a/_ressources/UML diagrams/SequenceDiagrams.md +++ b/_ressources/UML diagrams/SequenceDiagrams.md @@ -47,30 +47,8 @@ [Back to Top](#table-of-contents) -```mermaid -sequenceDiagram - participant User/Guest - participant Client - participant Server - participant Database - - User/Guest ->>+ Client: Search dog trainer request - Client ->> Client: Validate query - alt Invalid query - Client -->> User/Guest: Error: Invalid search query - else Valid query - Client ->>+ Server: search({query}) - - Server ->>+ Database: findTrainerByQuery({query}) - alt Trainers found - Database -->>+ Server: List of trainers found ([trainers]) - Server -->> Client: Return filtered trainer list - else No trainers found - Database -->>+ Server: Empty array (no trainers found) - Server -->> Client: Message: No trainers found matching the search - end - end -``` +![UML Diagram Use Case of PawPlanner](./assets/sequences/findTrainer.svg) + --- --- @@ -80,109 +58,24 @@ sequenceDiagram [Back to Top](#table-of-contents) -```mermaid -sequenceDiagram - participant Dog_Trainer - participant Client - participant Server - participant Database - - Dog_Trainer ->>+ Client: Selects date, time, and service - Client ->>+ Server: formData(appointment) - Server ->>+ Database: checkAvailability({date, time}) - alt Slot available - Database -->>+ Server: Slot is available - Server ->>+ Database: create({appointment}) - Database -->> Server: Appointment confirmed - Server -->> Client: Send confirmation - Client -->> Dog_Trainer: Display confirmation message - else Slot unavailable - Database -->> Server: Slot is taken - Server -->> Client: Error: Slot unavailable - Client -->> Dog_Trainer: Display error message - end -``` - - Retours : - - Le rôle Dog_Trainer ne correspond à rien dans nos entités, il faut qu'on soit d'accord tout de suite : c'est soit trainer soit dog_trainer mais on doit garder les mêmes termes partout. Pareil pour appointment, c'est un terme qu'on utilise ? Je me souviens plus. - - pas de s à Select - - +![UML Diagram Use Case of PawPlanner](./assets/sequences/createEvent.svg) ## Read Appointment Sequence [Back to Top](#table-of-contents) -```mermaid -sequenceDiagram - participant Dog_Owner - participant Client - participant Server - participant Database - - Dog_Owner ->>+ Client: Request to view appointments - Client ->>+ Server: getAppointments(dog_trainer.id) - Server ->>+ Database: read(dog_trainer.id) - alt Appointments found - Database -->>+ Server: List of appointments found ([appointments]) - Server -->> Client: Return appointments list - else No appointments found - Database -->>+ Server: Empty array (no appointments found) - Server -->> Client: Message: No appointments available - end -``` +![UML Diagram Use Case of PawPlanner](./assets/sequences/readEventsByTrainerId.svg) ## Update Appointment Sequence [Back to Top](#table-of-contents) -```mermaid -sequenceDiagram - participant Dog_Trainer - participant Client - participant Server - participant Database - - Dog_Trainer ->>+ Client: Selects an appointment to update - Client ->> Client: Display current appointment details - Dog_Trainer ->> Client: Modify appointment information - Client ->>+ Server: putAppointments(appointment) - Server ->>+ Database: checkAvailability({id}) - alt Appointment found - Database -->>+ Server: Found appointment - Server ->>+ Database: update({appointment}) - Database -->> Server: Appointment updated - Server -->> Client: Send confirmation - Client -->> Dog_Trainer: Display updated appointment - else Appointment not found - Database -->> Server: Appointment not found - Server -->> Client: Error: Appointment does not exist - Client -->> Dog_Trainer: Display error message - end -``` +![UML Diagram Use Case of PawPlanner](./assets/sequences/updateEvent.svg) ## Delete Appointment Sequence [Back to Top](#table-of-contents) -```mermaid -sequenceDiagram - participant Dog_Trainer - participant Client - participant Server - participant Database - - Dog_Trainer ->>+ Client: Selects an appointment to delete - Client ->> Dog_Trainer: Confirm deletion - alt Confirmation - Client ->>+ Server: deleteAppointment({appointment.id}) - Server ->>+ Database: delete({appointment.id}) - Database -->> Server: Appointment deleted - Server -->> Client: Send confirmation - Client -->> Dog_Trainer: Display success message - else Cancellation - Client -->> Dog_Trainer: Deletion canceled - end -``` +![UML Diagram Use Case of PawPlanner](./assets/sequences/deleteEvent.svg) diff --git a/_ressources/UML diagrams/assets/sequences/createEvent.svg b/_ressources/UML diagrams/assets/sequences/createEvent.svg new file mode 100644 index 0000000..d24eb55 --- /dev/null +++ b/_ressources/UML diagrams/assets/sequences/createEvent.svg @@ -0,0 +1,3 @@ + + +
alt
alt
Trainer
Tra...
Web site
Web site
Select date , time and service
Select date , time and service
Web server
Web server
Send confirmation
Send confirmation
Create Event
Create Event
Database
Database
formData(event)
formData(event)
checkAvailability({date,time)}
checkAvailability({date,time)}
[ Slot available ]
[ Slot available ]
Event confirmed
Event confirmed
Slot is available
Slot is available
create({event})
create({event})
[ Slot unavailable ]
[ Slot unavailable ]
Slot is taken
Slot is taken
Error: Slot unavailable
Error: Slot unavailable \ No newline at end of file diff --git a/_ressources/UML diagrams/assets/sequences/deleteEvent.svg b/_ressources/UML diagrams/assets/sequences/deleteEvent.svg new file mode 100644 index 0000000..f2c9587 --- /dev/null +++ b/_ressources/UML diagrams/assets/sequences/deleteEvent.svg @@ -0,0 +1,3 @@ + + +
alt
alt
Trainer
Tra...
Web site
Web site
Confirm deletion
Confirm deletion
Select an event to delete
Select an event to delete
Web server
Web server
Delete event
Delete event
Database
Database
deleteEvent({event.id})
deleteEvent({event.id})
deleteEvent({event.id})
deleteEvent({event.id})
 [ Confirmation ]
 [ Confirmation ]
Event deleted
Event deleted
 [ Cancellation ]
 [ Cancellation ]
Display succes message
Display succes message
Deletion canceled
Deletion canceled
Send confirmation
Send confirmation \ No newline at end of file diff --git a/_ressources/UML diagrams/assets/sequences/findTrainer.svg b/_ressources/UML diagrams/assets/sequences/findTrainer.svg new file mode 100644 index 0000000..2814f4b --- /dev/null +++ b/_ressources/UML diagrams/assets/sequences/findTrainer.svg @@ -0,0 +1,3 @@ + + +
alt
alt
User / Owner
Use...
Web site
Web site
Return filtered trainer list
Return filtered trainer list
Search dog trainer request
Search dog trainer request
Web server
Web server
Find Trainer
Find Trainer
Database
Database
search({query})
search({query})
findTrainerByQuery({query})
findTrainerByQuery({query})
[ Trainers found ]
[ Trainers found ]
Empty array
Empty array
Message : No trainers found
Message : No trainers found
[ Trainers not found ]
[ Trainers not found ]
List of trainers ([trainers])
List of trainers ([trainers]) \ No newline at end of file diff --git a/_ressources/UML diagrams/assets/sequences/readEventsByTrainerId.svg b/_ressources/UML diagrams/assets/sequences/readEventsByTrainerId.svg new file mode 100644 index 0000000..5f3038a --- /dev/null +++ b/_ressources/UML diagrams/assets/sequences/readEventsByTrainerId.svg @@ -0,0 +1,3 @@ + + +
alt
alt
Owner
Own...
Web site
Web site
Request to view events
Request to view events
Web server
Web server
Read all events from trainer.id
Read all events fro...
Database
Database
getEvents(Trainer.id)
getEvents(Trainer.id)
read(Trainer.id)
read(Trainer.id)
[ Event found ]
[ Event found ]
List of events ([events])
List of events ([events])
[ No event found ]
[ No event found ]
Empty array
Empty array
Message: no events available
Message: no events available
Return events list
Return events list \ No newline at end of file diff --git a/_ressources/UML diagrams/assets/sequences/updateEvent.svg b/_ressources/UML diagrams/assets/sequences/updateEvent.svg new file mode 100644 index 0000000..1a6b9b8 --- /dev/null +++ b/_ressources/UML diagrams/assets/sequences/updateEvent.svg @@ -0,0 +1,3 @@ + + +
Modify event information
Modify event information
alt
alt
Trainer
Tra...
Web site
Web site
Display current event details
Display current event details
Select date , time and service
Select date , time and service
Web server
Web server
Send confirmation
Send confirmation
Update event
Update event
Database
Database
putEvent(event)
putEvent(event)
checkAvailability({id})
checkAvailability({id})
[ Event found ]
[ Event found ]
Event updated
Event updated
Found event
Found event
update({event})
update({event})
[ Event not found ]
[ Event not found ]
Event not found
Event not found
Error: Event does not exist
Error: Event does not exist \ No newline at end of file From 8ffbd3544696d0bb2c9f6fad7aa2562b9149ac24 Mon Sep 17 00:00:00 2001 From: Florian Schaessens Date: Fri, 25 Oct 2024 12:14:33 +0200 Subject: [PATCH 7/7] update folder name UML_diagrams to conception_ressources --- .../README.md | 0 .../SequenceDiagrams.md | 0 .../assets/sequences/createEvent.svg | 0 .../assets/sequences/deleteEvent.svg | 0 .../assets/sequences/findTrainer.svg | 0 .../assets/sequences/login.svg | 0 .../assets/sequences/logout.svg | 0 .../assets/sequences/readEventsByTrainerId.svg | 0 .../assets/sequences/register.svg | 0 .../assets/sequences/updateEvent.svg | 0 .../class.drawio.png | Bin .../diagramUseCase.md | 0 .../useCase.png | Bin 13 files changed, 0 insertions(+), 0 deletions(-) rename _ressources/{UML diagrams => conception_ressources}/README.md (100%) rename _ressources/{UML diagrams => conception_ressources}/SequenceDiagrams.md (100%) rename _ressources/{UML diagrams => conception_ressources}/assets/sequences/createEvent.svg (100%) rename _ressources/{UML diagrams => conception_ressources}/assets/sequences/deleteEvent.svg (100%) rename _ressources/{UML diagrams => conception_ressources}/assets/sequences/findTrainer.svg (100%) rename _ressources/{UML diagrams => conception_ressources}/assets/sequences/login.svg (100%) rename _ressources/{UML diagrams => conception_ressources}/assets/sequences/logout.svg (100%) rename _ressources/{UML diagrams => conception_ressources}/assets/sequences/readEventsByTrainerId.svg (100%) rename _ressources/{UML diagrams => conception_ressources}/assets/sequences/register.svg (100%) rename _ressources/{UML diagrams => conception_ressources}/assets/sequences/updateEvent.svg (100%) rename _ressources/{UML diagrams => conception_ressources}/class.drawio.png (100%) rename _ressources/{UML diagrams => conception_ressources}/diagramUseCase.md (100%) rename _ressources/{UML diagrams => conception_ressources}/useCase.png (100%) diff --git a/_ressources/UML diagrams/README.md b/_ressources/conception_ressources/README.md similarity index 100% rename from _ressources/UML diagrams/README.md rename to _ressources/conception_ressources/README.md diff --git a/_ressources/UML diagrams/SequenceDiagrams.md b/_ressources/conception_ressources/SequenceDiagrams.md similarity index 100% rename from _ressources/UML diagrams/SequenceDiagrams.md rename to _ressources/conception_ressources/SequenceDiagrams.md diff --git a/_ressources/UML diagrams/assets/sequences/createEvent.svg b/_ressources/conception_ressources/assets/sequences/createEvent.svg similarity index 100% rename from _ressources/UML diagrams/assets/sequences/createEvent.svg rename to _ressources/conception_ressources/assets/sequences/createEvent.svg diff --git a/_ressources/UML diagrams/assets/sequences/deleteEvent.svg b/_ressources/conception_ressources/assets/sequences/deleteEvent.svg similarity index 100% rename from _ressources/UML diagrams/assets/sequences/deleteEvent.svg rename to _ressources/conception_ressources/assets/sequences/deleteEvent.svg diff --git a/_ressources/UML diagrams/assets/sequences/findTrainer.svg b/_ressources/conception_ressources/assets/sequences/findTrainer.svg similarity index 100% rename from _ressources/UML diagrams/assets/sequences/findTrainer.svg rename to _ressources/conception_ressources/assets/sequences/findTrainer.svg diff --git a/_ressources/UML diagrams/assets/sequences/login.svg b/_ressources/conception_ressources/assets/sequences/login.svg similarity index 100% rename from _ressources/UML diagrams/assets/sequences/login.svg rename to _ressources/conception_ressources/assets/sequences/login.svg diff --git a/_ressources/UML diagrams/assets/sequences/logout.svg b/_ressources/conception_ressources/assets/sequences/logout.svg similarity index 100% rename from _ressources/UML diagrams/assets/sequences/logout.svg rename to _ressources/conception_ressources/assets/sequences/logout.svg diff --git a/_ressources/UML diagrams/assets/sequences/readEventsByTrainerId.svg b/_ressources/conception_ressources/assets/sequences/readEventsByTrainerId.svg similarity index 100% rename from _ressources/UML diagrams/assets/sequences/readEventsByTrainerId.svg rename to _ressources/conception_ressources/assets/sequences/readEventsByTrainerId.svg diff --git a/_ressources/UML diagrams/assets/sequences/register.svg b/_ressources/conception_ressources/assets/sequences/register.svg similarity index 100% rename from _ressources/UML diagrams/assets/sequences/register.svg rename to _ressources/conception_ressources/assets/sequences/register.svg diff --git a/_ressources/UML diagrams/assets/sequences/updateEvent.svg b/_ressources/conception_ressources/assets/sequences/updateEvent.svg similarity index 100% rename from _ressources/UML diagrams/assets/sequences/updateEvent.svg rename to _ressources/conception_ressources/assets/sequences/updateEvent.svg diff --git a/_ressources/UML diagrams/class.drawio.png b/_ressources/conception_ressources/class.drawio.png similarity index 100% rename from _ressources/UML diagrams/class.drawio.png rename to _ressources/conception_ressources/class.drawio.png diff --git a/_ressources/UML diagrams/diagramUseCase.md b/_ressources/conception_ressources/diagramUseCase.md similarity index 100% rename from _ressources/UML diagrams/diagramUseCase.md rename to _ressources/conception_ressources/diagramUseCase.md diff --git a/_ressources/UML diagrams/useCase.png b/_ressources/conception_ressources/useCase.png similarity index 100% rename from _ressources/UML diagrams/useCase.png rename to _ressources/conception_ressources/useCase.png