README

A small framework and library for creating PHP applications.

Documentation

Requirements (PHP >= 8.1):

composer require diversen/pebble-framework:^10.0

Clone the repo:

git clone git@github.com:diversen/pebble-framework.git && cd pebble-framework

The framework is coupled against MySQL, so in order to run the tests you will need to edit config/DB.php.

You should add a config-locale folder and copy the DB.php file into this folder.

mkdir config-locale && cp config/DB.php config-locale/

config-locale is in .gitignore to make sure the folder is not commited and stays locale.

Edit the config-locale/DB.php file and add a valid database, username, and password

Install dependencies (there is only require-dev dependencies):

composer install

Check if you can connect:

./cli.sh db --con

Run DB migrations

./cli.sh migrate --up

Then run the unit tests:

./test.sh

Install:

composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer
./tools/php-cs-fixer.sh

Install (run) a MySQL image that will work:

docker run -p 3306:3306 --name mysql-server -e MYSQL_ROOT_PASSWORD=password -d mysql:8.0

Create a database:

./cli.sh db --server-connect
CREATE DATABASE `pebble`;

Install (run) a MySQL image that will work:

docker run -p 3306:3306 --name mysql-server -e MYSQL_ROOT_PASSWORD=password -d mysql:8.0

List containers

docker container ls

Stop container (mysql-server):

docker stop mysql-server

Start container (mysql-server) again:

docker start mysql-server

Remove container (you will need to run the 'run' command again):

docker rm mysql-server