Skip to content

Setup / Install

About

The pebble-framework is a small framework for making php applications.

Requirements:

PHP >= 8.1

Install as dependency:

composer require diversen/pebble-framework:^10.0

Run documentation examples

You may clone the pebble-framework-docs in order to easily run and edit all code examples:

git clone https://github.com/diversen/pebble-framework-docs.git 
cd pebble-framework-docs
composer install

Notice that all classes in src are autoloaded as the namespace App. This is done by setting the autoload setting in composer.json to the following:

"autoload": {
    "psr-4": {"App\\": "src/"}
}

If you want to run all code examples you will need access to a MySQL database.

Docker MySQL

If you don't have access to a MySQL database you may install a MySQL docker image that will work. The root user is given the password password in the following install:

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`;

If you can not connect (or you have a different user and password), then edit the database configuration file:

config-locale/DB.php ->

<?php

return [
    'url' => 'mysql:host=127.0.0.1;dbname=pebble',
    'username' => 'root',
    'password' => 'password',
];

Other docker commands

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

Edit this page on GitHub