Provides Eole domain, a RestAPI, and a websocket server.
Allows to plug new API endpoints and websocket topics easily for games.
This application requires Docker and docker-compose.
Or, without docker, it requires PHP 5.5+, ZMQ and php-zmq extension.
Install ZMQ and php-zmq on Linux
# Clone project
git clone [email protected]:eole-io/eole-api.git --branch=dev
cd eole-api
# Install Eole
make
# Sometimes needed
chmod -R 777 var/cache var/logs
chown -R GROUP:USER .
Youn should now access to:
- http://0.0.0.0:8480/api-docker.php/api/games Eole Api
- http://0.0.0.0:8480/api-docker.php/_profiler/ Symfony profiler
- http://0.0.0.0:8481/ PHPMyAdmin (
root
/root
) - http://0.0.0.0:8482/ Websocket server
Access to the Symfony console:
make bash
bin/console --env=docker
✔️ The installation is done.
Note: To install Eole Api on RaspberryPi, do
cp docker/docker-compose.arm.yml docker-compose.override.yml
beforemake
# Clone project
git clone [email protected]:eole-io/eole-api.git --branch=dev
cd eole-api
# Install dependencies
composer update
# Configuration files
cp config/environment.yml.dist config/environment.yml
cp config/environment_prod.yml.dist config/environment_prod.yml
- Edit configuration files,
- create a database which matches config.
# Create database schema
php bin/console orm:schema-tool:create
# And finally, install natives games:
php bin/console eole:games:install
Run React server (push server and websocket server)
php bin/react-server
✔️ The installation is done.
Note: Redirect react server logs.
The command
bin/react-server
is blocking. You may want to run:
php bin/react-server > var/logs/react-server.log &
Another note: Prod environment.
All bin commands have a
prod
mode, you can do instead in a prod environment:
composer update --no-dev
php bin/console --env=prod
php bin/react-server --env=prod
This project is under AGPL-v3 License.