Running Locally

To make things easier for everyone, this project is setup to use docker-compose. To make it easier for everyone, a shell script that creates all required files can be executed by running ./bootstrap.sh from the project folder. In a nutshell, this script:

• Checks for config.ini and creates one if missing.
• Checks for .env and creates one if missing.
• Checks for the SQLite database and creates one if missing, prompting the user for an admin password.
• Checks for vendor folder and runs composer install if missing.

No local PHP is required to run this script, everything runs with docker to avoid local dependencies as much as possible.

After the setup steps are completed, the project can be started by running:

docker-compose up

Once the servers are running, 2 ports are exposed:

• 8080: The PHP development server
• 4040: ngrok inspector

If you prefer to run the server in the background, just do

docker-compose up -d