popphp/popphp-framework

The Pop PHP Framework - Full Installation

Pop PHP Framework

, _(*1)

, _(*2)

• Overview
• New Features
• Install
• Kettle
• Support

Release Information

Pop PHP Framework 5.5.0
Released February 12, 2025, _(*3)

Overview

This repository contains the composer.json file to install the full Pop PHP Framework. The core Pop PHP components and the additional components listed below will be installed:, _(*4)

New Features

• A large number of improvements, upgrades and refactors across many components.
• Support for PHP 8.2+.
• PHPUnit tests refactored for PHPUnit 11.5+.
• Reference the CHANGELOG.md for further details.

Top, _(*5)

Install

There are multiple ways you can get Pop PHP Framework into your project., _(*6)

Option 1: Create a New Project

You can create a new project with the composer create-project command, which is recommended. This way, you will have access to the CLI-helper script kettle in the main project folder:, _(*7)

$ composer create-project popphp/popphp-framework project-folder

Option 2: Clone the Repo

You can clone this repository directly, which will also install the kettle script in the main project folder:, _(*8)

$ git clone https://github.com/popphp/popphp-framework.git popphp
$ cd popphp
$ composer install

Option 3: Use composer require

You can add it to an existing project with the composer require command:, _(*9)

$ composer require popphp/popphp-framework

Option 4: Use composer.json

You can add it your project's composer.json file:, _(*10)

"require": {
    "popphp/popphp-framework": "^5.5.0"
}

Top, _(*11)

Kettle

CLI Helper

pop-kettle, _(*12)

If choose to install the framework in a way that the pop-kettle CLI-helper script is not available in the main project folder (options 3 and 4), you can place a copy of the script from the vendor/popphp/pop-kettle/kettle location in the main project folder (adjacent to the vendor folder):, _(*13)

$ cp vendor/popphp/pop-kettle/kettle .
$ cp vendor/popphp/pop-kettle/kettle.inc.php .

Once you've copied the scripts over, you have to change the reference to the script's config file from:, _(*14)

    $app = new Pop\Application(
        $autoloader, include __DIR__ . '/config/app.console.php'
    );

to, _(*15)

    $app = new Pop\Application(
        $autoloader, include __DIR__ . '/vendor/popphp/pop-kettle/config/app.console.php'
    );

and make sure the newly copied kettle script is set to execute (755), _(*16)

$ chmod 755 kettle

Top, _(*17)

Support

The best way to directly interact with Pop PHP is here on GitHub. You can:, _(*18)

• Contribute code
• Request a feature
• Report an issue

but please do so under the pertinent repository related to the topic at hand., _(*19)

Besides interacting with the various repositories here on GitHub, there are a few other ways to participate in the Pop PHP community:, _(*20)

• Discord
• X

Top, _(*21)