Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristianFN2 committed Mar 3, 2024
1 parent f79168d commit 0009576
Show file tree
Hide file tree
Showing 9 changed files with 69 additions and 61 deletions.
Binary file modified images/Context Diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/Generated Questions API (WhiteBox).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/QualityTree.png
Binary file not shown.
Binary file added images/Sequence diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/Whitebox overall system.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/game diagram.png
Binary file not shown.
Binary file removed images/questions diagram.png
Binary file not shown.
Binary file removed images/users diagram.png
Binary file not shown.
130 changes: 69 additions & 61 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -447,8 +447,7 @@ <h1><span class="image"><img src="./images/arc42-logo.png" alt="arc42"></span> T
<li><a href="#section-introduction-and-goals">1. Introduction and Goals</a>
<ul class="sectlevel2">
<li><a href="#_requirements_overview">1.1. Requirements Overview</a></li>
<li><a href="#_quality_goals">1.2. Quality Goals</a></li>
<li><a href="#_stakeholders">1.3. Stakeholders</a></li>
<li><a href="#_stakeholders">1.2. Stakeholders</a></li>
</ul>
</li>
<li><a href="#section-architecture-constraints">2. Architecture Constraints</a></li>
Expand All @@ -470,6 +469,10 @@ <h1><span class="image"><img src="./images/arc42-logo.png" alt="arc42"></span> T
<li><a href="#_access_to_user_data_via_api">6.2. Access to user data via API</a></li>
<li><a href="#_access_to_questions_data_via_api">6.3. Access to questions data via API</a></li>
<li><a href="#_game">6.4. Game</a></li>
<li><a href="#_runtime_scenario_1">6.5. &lt;Runtime Scenario 1&gt;</a></li>
<li><a href="#_runtime_scenario_2">6.6. &lt;Runtime Scenario 2&gt;</a></li>
<li><a href="#">6.7. &#8230;&#8203;</a></li>
<li><a href="#_runtime_scenario_n">6.8. &lt;Runtime Scenario n&gt;</a></li>
</ul>
</li>
<li><a href="#section-deployment-view">7. Deployment View</a>
Expand All @@ -489,7 +492,6 @@ <h1><span class="image"><img src="./images/arc42-logo.png" alt="arc42"></span> T
<li><a href="#section-quality-scenarios">10. Quality Requirements</a>
<ul class="sectlevel2">
<li><a href="#_quality_tree">10.1. Quality Tree</a></li>
<li><a href="#_quality_scenarios">10.2. Quality Scenarios</a></li>
</ul>
</li>
<li><a href="#section-technical-risks">11. Risks and Technical Debts</a></li>
Expand Down Expand Up @@ -609,10 +611,9 @@ <h3 id="_requirements_overview">1.1. Requirements Overview</h3>
</div>
</div>
<div class="paragraph">
<p>The functional requirements have been grouped into the different microservices the web application will have.</p>
<p>The functional requirements have been grouped into the different microservices the web application will have.
==== User and Authorization Services</p>
</div>
<div class="sect3">
<h4 id="_user_and_authorization_services">1.1.1. User and Authorization Services</h4>
<div class="olist decimal">
<ol class="decimal">
<li>
Expand Down Expand Up @@ -671,9 +672,8 @@ <h4 id="_user_and_authorization_services">1.1.1. User and Authorization Services
</li>
</ol>
</div>
</div>
<div class="sect3">
<h4 id="_question_service">1.1.2. Question Service</h4>
<h4 id="_question_service">1.1.1. Question Service</h4>
<div class="olist decimal">
<ol class="decimal" start="5">
<li>
Expand Down Expand Up @@ -718,14 +718,11 @@ <h4 id="_question_service">1.1.2. Question Service</h4>
</div>
</li>
<li>
<p>The questions should be selected randomly.</p>
<p>The questions should be selected randomly.
=== Quality Goals</p>
</li>
</ol>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_quality_goals">1.2. Quality Goals</h3>
<div class="sidebarblock arc42help">
<div class="content">
<div class="paragraph">
Expand Down Expand Up @@ -785,8 +782,9 @@ <h3 id="_quality_goals">1.2. Quality Goals</h3>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="_stakeholders">1.3. Stakeholders</h3>
<h3 id="_stakeholders">1.2. Stakeholders</h3>
<div class="sidebarblock arc42help">
<div class="content">
<div class="paragraph">
Expand Down Expand Up @@ -1013,7 +1011,7 @@ <h3 id="_business_context">3.1. Business Context</h3>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/Context%20Diagram.png" alt="Context Diagram" width="348" height="483">
<img src="./images/Context%20Diagram.png" alt="Context Diagram" width="343" height="483">
</div>
</div>
<table class="tableblock frame-all grid-all stretch">
Expand All @@ -1033,28 +1031,24 @@ <h3 id="_business_context">3.1. Business Context</h3>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Plays the game and can consult past scores</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Client</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Can access the data about players and generated questions</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>WIQ Game</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Main system in which generated questions are shown and can be answered by players</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Wikidata</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>External data repository from which questions are generated using the WikidataAPI</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>External data repository from which questions are generated</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>MongoDB</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Database for storing generated questions, players' info and scores</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Database for storing players' info and scores</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Users Info API</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Allows clients to see the info about players stored in the database</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Manages data of users, both registration/login data and their past scores</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Generated Questions API</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Allows clients to see the info about generated questions stored in the database</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Manages generation of questions from Wikidata</em></p></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -1251,12 +1245,8 @@ <h3 id="_whitebox_overall_system">5.1. Whitebox Overall System</h3>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Main window in which questions are shown and can be answered by the player. The latter can also see past scores.</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Data View</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Access to data about users and generated questions for the client.</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Generated Questions API</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>In charge of generating the questions and storing their data</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>In charge of generating the questions</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>UsersAPI</em></p></td>
Expand Down Expand Up @@ -1361,7 +1351,7 @@ <h4 id="_generated_questions_api_white_box">5.2.1. Generated Questions API (Whit
</div>
<div class="imageblock">
<div class="content">
<img src="./images/Generated%20Questions%20API%20(WhiteBox).png" alt="Generated Questions API (WhiteBox)" width="387" height="337">
<img src="./images/Generated%20Questions%20API%20(WhiteBox).png" alt="Generated Questions API (WhiteBox)" width="389" height="337">
</div>
</div>
<div class="dlist">
Expand All @@ -1387,35 +1377,18 @@ <h4 id="_generated_questions_api_white_box">5.2.1. Generated Questions API (Whit
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>GenQuestsService</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Receives different petitions regarding the generation of questions or their retrieval and responds accordingly.</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Receives different petitions regarding the generation of questions and responds accordingly.</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>wikidatanpm</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>wikibase-sdk</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>External library that facilitates and simplifies the use of wikidata for the generation of questions.</em></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>MongoDB</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>The data of the generated questions is stored here for showing it later to the client.</em></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Data about users and their scores is stored here</em></p></td>
</tr>
</tbody>
</table>
<div class="dlist">
<dl>
<dt class="hdlist1">Additional explanation of relationships</dt>
<dd>
<p>The service is requested either the generation of a question or the retrieval of a subset (from WIQ Game GUI or
Data View respectively).</p>
</dd>
</dl>
</div>
<div class="paragraph">
<p>For the first case, it makes use of the library to generate the question, retrieves it
for the interface to use and stores the pertinent data in the DB.</p>
</div>
<div class="paragraph">
<p>In the other case, it just makes the query according to the client choosings and retrieves the data of the
questions for the Data View to show.</p>
</div>
<div style="page-break-after: always;"></div>
</div>
</div>
Expand Down Expand Up @@ -1448,7 +1421,7 @@ <h3 id="_access_to_user_data_via_api">6.2. Access to user data via API</h3>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/users%20diagram.png" alt="users diagram" width="211" height="227">
<img src="./images/Sequence%20diagram.png" alt="Sequence diagram" width="211" height="227">
</div>
</div>
</div>
Expand All @@ -1463,7 +1436,7 @@ <h3 id="_access_to_questions_data_via_api">6.3. Access to questions data via API
</div>
<div class="imageblock">
<div class="content">
<img src="./images/questions%20diagram.png" alt="questions diagram" width="224" height="227">
<img src="./images/Sequence%20diagram.png" alt="Sequence diagram" width="224" height="227">
</div>
</div>
</div>
Expand All @@ -1478,7 +1451,7 @@ <h3 id="_game">6.4. Game</h3>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/game%20diagram.png" alt="game diagram" width="387" height="365">
<img src="./images/Sequence%20diagram.png" alt="Sequence diagram" width="387" height="365">
</div>
</div>
<div class="sidebarblock arc42help">
Expand Down Expand Up @@ -1543,6 +1516,39 @@ <h3 id="_game">6.4. Game</h3>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_runtime_scenario_1">6.5. &lt;Runtime Scenario 1&gt;</h3>
<div class="ulist">
<ul>
<li>
<p><em>&lt;insert runtime diagram or textual description of the scenario&gt;</em></p>
</li>
<li>
<p><em>&lt;insert description of the notable aspects of the interactions between the
building block instances depicted in this diagram.&gt;</em></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>It is possible to use a sequence diagram:</p>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/Sequence%20diagram.png" alt="Sequence diagram" width="332" height="335">
</div>
</div>
</div>
<div class="sect2">
<h3 id="_runtime_scenario_2">6.6. &lt;Runtime Scenario 2&gt;</h3>

</div>
<div class="sect2">
<h3 id="">6.7. &#8230;&#8203;</h3>

</div>
<div class="sect2">
<h3 id="_runtime_scenario_n">6.8. &lt;Runtime Scenario n&gt;</h3>
<div style="page-break-after: always;"></div>
</div>
</div>
Expand Down Expand Up @@ -1985,14 +1991,16 @@ <h3 id="_quality_tree">10.1. Quality Tree</h3>
</div>
</div>
</div>
<div class="imageblock">
<div class="content">
<img src="./images/QualityTree.png" alt="The Quality Tree of the project">
</div>
</div>
<div class="paragraph">
<p>@startmindmap
* Quality
<strong> Testability
</strong> Usability
<strong> Portability
</strong> Performance
@endmindmap
=== Quality Scenarios</p>
</div>
<div class="sect2">
<h3 id="_quality_scenarios">10.2. Quality Scenarios</h3>
<div class="sidebarblock arc42help">
<div class="content">
<div class="paragraph">
Expand Down Expand Up @@ -2032,7 +2040,7 @@ <h3 id="_quality_scenarios">10.2. Quality Scenarios</h3>
</div>
</div>
<div class="sect3">
<h4 id="_usage_scenarios">10.2.1. Usage Scenarios</h4>
<h4 id="_usage_scenarios">10.1.1. Usage Scenarios</h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
Expand Down Expand Up @@ -2077,7 +2085,7 @@ <h4 id="_usage_scenarios">10.2.1. Usage Scenarios</h4>
</table>
</div>
<div class="sect3">
<h4 id="_change_scenarios">10.2.2. Change Scenarios</h4>
<h4 id="_change_scenarios">10.1.2. Change Scenarios</h4>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 25%;">
Expand Down

0 comments on commit 0009576

Please sign in to comment.