https://github.com/diversen/pebble-framework

A simple, small, and fast php framework.
https://github.com/diversen/pebble-framework

php-framework php-library simple-php-framework small-php-framework

Last synced: 12 months ago
JSON representation

A simple, small, and fast php framework.

• Host: GitHub
• URL: https://github.com/diversen/pebble-framework
• Owner: diversen
• Created: 2021-07-29T13:46:38.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-07-22T10:56:29.000Z (about 2 years ago)
• Last Synced: 2024-11-13T23:48:13.016Z (over 1 year ago)
• Topics: php-framework, php-library, simple-php-framework, small-php-framework
• Language: PHP
• Homepage:
• Size: 3.53 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# pebble-framework

A small framework and library for creating PHP applications.

# Documentation 

[https://diversen.github.io/pebble-framework-docs/](https://diversen.github.io/pebble-framework-docs/)

# Install

Requirements (PHP >= 8.1):

    composer require diversen/pebble-framework:^10.0

# Install for testing

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](.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

# Clean up

Install:

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

    ./tools/php-cs-fixer.sh

# Docker MySQL

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

# Other docker commands

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

# License

MIT © [Dennis Iversen](https://github.com/diversen)