Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Some updates in the documentation #98

Merged
merged 3 commits into from
Mar 10, 2024
Merged

Some updates in the documentation #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a3ab99
chore: Added question generator to the glossary
UO283615 Mar 8, 2024
46ae6d7
Chore: Updated the class diagram
UO283615 Mar 8, 2024
17fbf24
chore: removed unecessary terms from the glossary
UO283615 Mar 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 25 additions & 9 deletions docs/src/08_concepts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,44 @@ This is the first version of the diagram, it will be updated if needed.
----
@startuml

enum Category {
enum QuestionCategory {
HISTORY
GEOGRAPHY
SCIENCE
MATH
LITERATURE
ART
SPORTS
}

enum Type {
enum AnsswerCategory {
CITY
COUNTRY
PERSON
DATE
OTHER
}

enum QuestionType{
TEXT
IMAGE
AUDIO
}

class Question{
id: long
content: String
answers: List<Answer>
correct: Answer
category: Category
correctAnswer: Answer
questionCategory: QuestionCategory
answerCategory: AnswerCategory
language: String
Type: Type
QuestionType: Type
}

class User{
username: String
email: String
password: String
answeredQuestions: int
}

Expand All @@ -41,8 +56,9 @@ class UserStat{

class Answer {
text: String
category: Category
Type: Type
category: AnswerCategory
questionsWithThisAnswer: List<Question>

}

class Game {
Expand All @@ -52,7 +68,7 @@ class Game {


class Ranking << Singleton >> {

}

User o--> Question
Expand Down
11 changes: 2 additions & 9 deletions docs/src/12_glossary.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,6 @@ ifndef::imagesdir[:imagesdir: ../images]
[cols="e,2e" options="header"]
|===
|Term |Definition

|React
|An open-source JavaScript library for developing user interfaces. It can be used to develop web applications, and it has to be complemented with other libraries to develop full-fledged products.

|SpringBoot
|Java Spring Boot (Spring Boot) is a tool that makes developing web application and microservices with Spring Framework faster and easier through three core capabilities: Autoconfiguration, an opinionated approach to configuration, the ability to create standalone applications.

|PostgreSQL
|Object-relational database management system (ORDMBS), which means that it has relational capabilities and an object-oriented design
|Question Generator
|A module of the application responsible for querying Wikidata, creating the questions and storing them in our DB.
|===