Architecture of Crosswordpuzzle

Purpose

The user can play a crosswordpuzzle out of given questions.

Table of Contents

• Links

• General code structure

• Starting the service

• What to look at

• What to ignore

• Known Design Flaws

• Known Bugs

• Tests

Links

• The user docs explain how to play the game.

• The program code is available here.

• The overview of the architecture can be found here.

• The backend architecture is described here.

General code structure

• assets: Static assets like the logo

• components: Re-usable Vue components

• router: Frontend site page routing

• ts: Data models and backend communication

• types: Types of the crosswordpuzzle

• store: Store to get data between views

• views: The displayed pages. Currently consists of only the GameView that contains the whole game

Starting the service

See the README.

What to look at

Everything

What to ignore

NA

Known Design Flaws

Nothing

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 Crosswordpuzzle.

Tests

In general, the following things are tested for Crosswordpuzzle:

• everything manually with a testplan

• Unit tests for Sonarqube funtionality