# Architecture of Finitequiz-backend

Finitequiz is a minigame which is part of the Gamify-IT platform.
The intention with this game is to make answering single choice questions fun.

## Table of Contents

* [Links](#links)
* [General code structure](#general-code-structure)
* [Starting the service](#starting-the-service)
* [What to look at](#what-to-look-at)
* [What to ignore](#what-to-ignore)
* [Class diagrams](#class-diagrams)
    * [Overview complete application](#overview-complete-application)
    * [ConfigController](#configcontroller)
    * [GameResultController](#gameresultcontroller)
* [Known Design Flaws](#known-design-flaws)
* [Known Bugs](#known-bugs)
* [Tests](#tests)

## Links

- The [user docs](../../../user-manuals/minigames/finitequiz.md) explain how to play the game.
- The program code is available [here](https://github.com/Gamify-IT/finitequiz-backend).
- The overview of the architecture can be found [here](../general-architecture.md).
- The frontend architecture is described [here](../finitequiz/README.md).

## General code structure

This [Java backend](https://github.com/Gamify-IT/finitequiz-backend/tree/main/src/main/java/de/unistuttgart/finitequizbackend) has the following package structure
- `data`: Contains the data objects and DTOs
- `controllers`: Containers the server routes
- `services`: Contains the business logic
- `clients`: Contains the b2b (backend-2-backend) communication methods
- `repositories`: Contains the database repositories


## Starting the service

See the [README](https://github.com/Gamify-IT/finitequiz-backend#readme).

## What to look at

The controllers for the API requests are a good point to start.  
From there you can follow the code flow to the other components.

- The [GameResultController](https://github.com/Gamify-IT/finitequiz-backend/blob/main/src/main/java/de/unistuttgart/finitequizbackend/controller/GameResultController.java) provides the API for the game results.
- The [ConfigController](https://github.com/Gamify-IT/finitequiz-backend/blob/main/src/main/java/de/unistuttgart/finitequizbackend/controller/ConfigController.java) provides the API to configure the game.

## What to ignore

Nothing at the moment.

## Class diagrams

### Overview complete application
![overview class diagram of complete application](assets/finitequiz-class-overview.webp)
This simplified class diagram shows how the most important services, mappers and repositories in the project are interlinked.

### ConfigController
![class diagram of ConfigController](assets/finitequiz-config-controller.svg)
This class diagram shows an overview of the ConfigController class.

### GameResultController
![class diagram GameResultController](assets/finitequiz-game-result-controller.svg)
This class diagram shows an overview of the GameResultController class.
The data structure of `GameResult` and its contents are shown at the left and bottom of the diagram.

## Known Design Flaws

There are no known design flaws.

## Known Bugs

An up-to-date list of open bugs can be found at <https://github.com/orgs/Gamify-IT/projects/6/views/11> by searching for Finitequiz-backend.

## Tests

We use the following test strategies in the Finitequiz-backend:

- unit tests