Diagrams

[DavidPedregal]

Here we can upload our diagrams, screen concepts... so we can give feedback.

[franCimadevilla]

I am creating the documentation of the application architecture we have discussed in the last meeting. Is more or less what all we agree about? Should I consider any change?

I am attaching also the descriptions I consider for each module. I took the text directly from the documentation extract 4.2 Arquitectural design decisions.

=== 4.2 Architectural design decisions
The project arquitecture is divided in diferent modules and their functionalities are delimited following a Layered pattern. Therefore, taking that in mind we can classify the project as follows.

1. View

   • Webapp
     Module that manages the pages shown to the client and communicates with the Gateway module via requests.

2. Controller

   • Gateway
     Endpoint of the web application that communicates the frontend with the business logic

3. Services

   • UserAuthentication
     Module that manages the login operation and verifies the client connection
   • UserManager
     Module that carries the CRUD operations with users with the DB. Moreover, it also manages group of users and retrieve all user related information.
   • GameService
     Module that carries the game logic of the application quizzes, interacts with the LLMService and with WikiData interface.
   • LLMService
     Module that acts as an interface to communicate with the LLM provider API in a decoupled way. Allowing the application to consider future changes in the API provider with the same functionality.

4. Persistence

   • Mongoose (MongoDB)
     Module of persistence that storages the users information in JSON format.

[DavidPedregal]

I am creating the documentation for the issue 6. The diagrams I was thinking were the most relevant are:

• Login
• Game example
• Start / stop application

What do you think about the Login diagram? I am not completely sure about the returning part, it might contain errors.

I was thinking that maybe you don't want that much detail about the services. Do you prefer if I replace everything but User and MongoDB for WichatEN2B?

Do you think there are more relevant scenarios?

[DavidPedregal]

Note: I did not consider in the diagram the possible errors that could happen like wrong credentials, that will be explained in a different part of the same issue