Crosswordpuzzle

This is a simple crosswordpuzzle. With given questions and answers it automatically generates a crosswordpuzzle.

Development

Getting started

Beginning of additions (that work)

Clone the repository

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

Install the dependencies

npm install

Compile and Hot-Reload for Development

If you want to run the frontend with your IDE features, whilst having all dependencies running via docker use the following: Start the frontend with:

npm run serve

To also run the backend and a database use:

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

To remove the containers use:

docker compose -f docker-compose-dev.yaml down

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

User manual

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

docker run -d -p 8000:80 --name crosswordpuzzle ghcr.io/gamify-it/crosswordpuzzle: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=crosswordpuzzle

To stop the container you can use the following command:

docker stop crosswordpuzzle

To remove the container you can use the following command:

docker rm crosswordpuzzle

Screenshot