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.

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

Add bugfinder backend architecture file #179

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
65 changes: 65 additions & 0 deletions dev-manuals/architecture/bugfinder-backend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Architecture of Bugfinder-backend

Bugfinder is a minigame which is part of the Gamify-IT platform.

## 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/bugfinder.md) explain how to play the game.
- The program code is available [here](https://github.com/Gamify-IT/bugfinder-backend).
- The overview of the architecture can be found [here](../general-architecture.md).
- The frontend architecture is described [here](../bugfinder/README.md).

## General code structure

This [Java backend](https://github.com/Gamify-IT/bugfinder-backend) has the following package structure
- `code`: Contains all files for code, like controller, repositories, service classes, entity classes, DTOs
- `configuration`: Contains all files for configuration, repositories, like controller, service classes, entity classes, DTOs
- `gameresult`: Contains all files for gameresult, repositories, like controller, service classes, entity classes, DTOs
- `solution`: Contains all files for solution, repositories, like controller, service classes, entity classes, DTOs


## Starting the service

See the [README](https://github.com/Gamify-IT/bugfinder-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.

## What to ignore

Nothing at the moment.

## Class diagrams

**TODO**

## 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 Bugfinder-backend.

## Tests

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

- unit tests
2 changes: 1 addition & 1 deletion dev-manuals/architecture/bugfinder/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Architecture of `Bugfinder`
# Architecture of Bugfinder

## Purpose

Expand Down