diff --git a/.gitignore b/.gitignore index d40cde8..09edf85 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ # vscode config files ./.vscode/* +math_wizard_db_data/* \ No newline at end of file diff --git a/Dockerfile.math_wizard b/Dockerfile.math_wizard index dc3859f..845815e 100644 --- a/Dockerfile.math_wizard +++ b/Dockerfile.math_wizard @@ -1,5 +1,5 @@ # Verwende ein Basisimage mit PHP -FROM php:8.2-cli +FROM php:8.4-cli # Setze das Arbeitsverzeichnis WORKDIR /app diff --git a/README.md b/README.md new file mode 100644 index 0000000..82efbc1 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# The Math Wizard + +The Math Wizard is a browser game that helps children automate the 1x1. It acts as a dungeon crawler game in which children can fight monsters by solving multiplication problems. + +## Requirements + +To run the game, you need Docker and Docker-Compose. Make sure that these are installed and configured on your system. + +## Installation + +1. clone the repository with `git clone https://github.com/PatrykHegenberg/TheMathWizard.git`. +2. change to the project directory with `cd TheMathWizard`. +3. run `docker-compose up --build` to install and start the game. + +Once the installation is complete, you can access the game via your web browser under `localhost:8080` or the computer name. + +## Usage + +To create a new account, go to `localhost:8080/signup` in the browser. After signing up, you can start the game and begin fighting monsters and solving multiplication tasks. Your progress will be saved persistently on the hard disk of the host computer. + +## License + +This project is licensed under the MIT license. For more information, see the LICENSE file. + +## Acknowledgments + +This project uses the following resources: +- [ROT.js](https://github.com/ondras/rot.js/) (BSD-Lizenz) +- [Micro Rogue tileset](https://kenney.nl/assets/micro-roguelike) von Kenney.nl (CC0 1.0 Universelle Lizenz) +- [NES.css](https://nostalgic-css.github.io/NES.css/) (MIT Lizenz) +- [sfxr.me](https://www.sfxr.me/) (Öffentliches Domain) +- [Pixel Coin Bild](https://opengameart.org/content/pixel-coins) (CC-BY 3.0 Lizenz) +- [Roguelike-Browser-Boilerplate](https://github.com/chr15m/roguelike-browser-boilerplate) diff --git a/docker-compose.yml b/docker-compose.yml index b22948e..4642444 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -4,7 +4,6 @@ services: web: #image: math_wizard build: - context: /home/pata/dev/WebProg/TheMathWizard dockerfile: Dockerfile.math_wizard ports: - "8080:8080" @@ -15,7 +14,6 @@ services: db: build: - context: /home/pata/dev/WebProg/TheMathWizard dockerfile: Dockerfile.db environment: MYSQL_ROOT_PASSWORD: password diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..7190a60 --- /dev/null +++ b/renovate.json @@ -0,0 +1,3 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json" +}