Skip to content

Minigame to practise finding and fixing bugs in a snippet

License

Notifications You must be signed in to change notification settings

Gamify-IT/bugfinder

Repository files navigation

Bugfinder

grafik

This is a game where you have to find bugs. You have to find click on the position in the code that causes the bug and get chat-like feedback.

This repository contains the frontend for the Bugfinder minigame.

Development

Beginning of additions (that work)

Getting started

Clone the repository

git clone https://github.com/Gamify-IT/bugfinder.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

End of additions

Test

Run the tests:

npm run test:unit

To also get the test coverage:

npm run test:unit -- --coverage

Build

Build the Docker-Container

docker build -t bugfinder-dev .

And run it at port 8000 with

docker run -d -p 8000:80 --name bugfinder-dev bugfinder-dev

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

docker ps -a -f name=bugfinder-dev
docker stop bugfinder-dev
docker rm bugfinder-dev

User manual

Run the docker container with the following command at port 8000:

docker run -d -p 8000:80 --name bugfinder ghcr.io/gamify-it/bugfinder:latest

Now you can access it at http://localhost:8000.
To access it externally replace localhost with your IP.

To monitor the container you can use the following command:

docker ps -a -f name=bugfinder

To stop the container you can use the following command:

docker stop bugfinder

To remove the container you can use the following command:

docker rm bugfinder

Audio sources

  1. Background music https://pixabay.com/de/music/optimistisch-walking-while-looking-at-the-moon-187621/

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

  3. Error notification https://pixabay.com/de/sound-effects/error-126627/

  4. Classic notifications from the chat https://pixabay.com/de/sound-effects/notifications-sound-127856/

  5. Success notification https://pixabay.com/de/sound-effects/short-success-sound-glockenspiel-treasure-video-game-6346/