README.md

Finitequiz

This repository contains the frontend for the Finitequiz minigame.

Table of contents

• Links
• Development
  • Getting started
    • Run with Docker-compose
  • Compile and Hot-Reload for Development
  • Test
  • Build

Links

• User documentation for the minigame can be found here.
• For the backend, see the Gamify-IT/finitequiz-backend repository.
• The installation manual and setup instructions can be found here.

Development

Beginning of additions (that work)

Getting started

Clone the repository

git clone https://github.com/Gamify-IT/finitequiz.git

Install the dependencies

npm install

Compile and Hot-Reload for Development

To run the project locally with your IDE feature and have all necessary dependencies running, start the dependencies via docker:

docker compose -f docker-compose-dev.yaml up

Then start the frontend with:

npm run serve

You can now access the game at localhost.

Build your local changes as a docker container

To build and run your local changes as a docker container use:

docker compose up --build

You can remove the container with:

docker compose down

To monitor, stop and remove the container you can use the following commands:

docker ps -a -f name=finitequiz-dev

docker stop finitequiz-dev

docker rm finitequiz-dev

Audio sources

1. Background music https://pixabay.com/de/music/schlagt-hail-126903/

2. Click sound https://pixabay.com/de/sound-effects/interface-button-154180/

3. Correct answer https://mixkit.co/free-sound-effects/correct/ (mixkit-correct-answer-tone-2870)

4. End screen sound https://mixkit.co/free-sound-effects/win/ (mixkit-melodic-bonus-collect-1938)

5. Wrong answer https://pixabay.com/de/sound-effects/error-126627/

End of additions