Go to file
2021-04-10 18:59:27 +02:00
.vscode MAPG-203 add debugger config for NodeJS 2021-03-20 19:44:48 +01:00
cache MAPG-89 add cache folder that can hold cache files 2020-06-27 00:44:38 +02:00
database MAPG-203 add new table and model for multi_room 2021-03-20 19:44:48 +01:00
docker MAPG-203 restructure Docker stack 2021-03-20 19:44:48 +01:00
mail MAPG-185 consolidation of email templates 2020-07-05 17:37:02 +02:00
multi MAPG-226 change remaining time calculation 2021-04-10 18:59:27 +02:00
public MAPG-213 move visibility workaround to Game.showResultMap 2021-04-04 23:40:27 +02:00
scripts MAPG-203 install NPM packages on install and update 2021-03-20 19:45:21 +01:00
src MAPG-223 send error if member already guessed 2021-04-04 23:28:44 +02:00
tests MAPG-199 move test views to another folder to prevent code analysis errors 2020-07-05 23:18:57 +02:00
views MAPG-205 add elements for showing countdown 2021-04-04 14:20:12 +02:00
.env.example MAPG-203 use MULTI_WS_URL environment variable 2021-03-20 21:21:40 +01:00
.gitattributes MAPG-81 update .gitattributes to store PNG files with Git LFS 2020-05-30 23:16:31 +02:00
.gitignore MAPG-203 add node_modules to gitignore 2021-03-17 23:09:07 +01:00
bitbucket-pipelines.yml MAPG-2020 run PHPStan with 1G memory limit 2021-01-01 22:34:32 +01:00
composer.json MAPG-203 add new Composer packages 2021-03-20 19:44:47 +01:00
composer.lock MAPG-203 add new Composer packages 2021-03-20 19:44:47 +01:00
docker-compose.yml MAPG-203 restructure Docker stack 2021-03-20 19:44:48 +01:00
LICENSE.md MAPG-78 change license to AGPL and include the license 2020-05-30 01:42:14 +02:00
main.php MAPG-142 redefine tokens and increase OAuth security with nonce 2020-07-05 14:24:05 +02:00
mapg MAPG-185 rename migrate database command 2020-07-05 16:45:38 +02:00
phpstan.neon MAPG-199 add static code analysis step to pipeline 2020-07-05 22:51:36 +02:00
README.md MAPG-201 update Git link to gitea.e5tv.hu 2020-12-27 23:08:30 +01:00
USED_SOFTWARE MAPG-73 add license of Boostrap Icons 2020-05-30 17:39:45 +02:00
web.php MAPG-203 add new routes for multiplayer 2021-03-20 19:45:21 +01:00

MapGuesser

This is the MapGuesser Application project. This is a game about guessing where you are based on a street view panorama - inspired by existing applications.

Installation

Clone the Git repository

The first step is obviously cloning the repository to your machine:

git clone https://gitea.e5tv.hu/esoko/mapguesser.git

All the commands listed here should be executed from the repository root.

(Optional) Setup Docker stack

The easiest way to build up a fully working application with web server and database is to use Docker Compose with the included docker-compose.yml.

All you have to do is executing the following command:

docker-compose up -d

Attach shell to the container of mapguesser_app. All of the following commands should be executed there.

If you don't use the Docker stack you need to install your environment manually. Check docker-compose.yml and docker/Dockerfile to see the system requirements.

Initialize project

This command installes all of the Composer requirements and creates a copy of the example .env file.

composer create-project

Set environment variables

The .env file contains several environment variables that are needed by the application to work properly. These should be configured for your environment.

You should set here the API keys that enable playing the game. Without these API keys the application cannot work well. To get Google API keys visit this page: https://console.developers.google.com/

One very important variable is DEV. This indicates that the application operates in development (staging) and not in produciton mode.

If you install the application in the Docker stack for development (staging) environment, only the variables for external dependencies (API keys, map attribution, etc.) should be adapted. All other variables (for DB connection, static root, mailing, etc.) are fine with the default value.

(Production only) Create cron job

To maintain database (delete inactive users, old sessions etc.), the command db:maintain should be regularly executed. It is recommened to create a cron job that runs every hour:

0 * * * * /path/to/your/installation/mapg db:maintain >>/var/log/cron-mapguesser.log 2>&1

Finalize installation

After you set the environment variables in the .env file, execute the following command:

scripts/install.sh

And you are done! The application is ready to use and develop.

If you installed it in the Docker stack, you can reach it on http://localhost. The mails that are sent by the application can be found on http://localhost:8080/. If needed, the database server can be directly reached on localhost:3306.


License: GNU AGPL 3.0. Full license text can be found in file LICENSE.