Framework

A PHP Framework, built for building fast: routes, models, listeners and settings are found by their attributes, turned into typed classes by a build step, and driven from a single ./framework CLI.

Read the documentation →

Requirements

PHP 8.1 or newer with the mysqli, curl, zip, gd and mbstring extensions, and a MySQL database.

Installation

Add the repository to the repositories:

"repositories": [
    {
        "type": "git",
        "url": "https://github.com/FrameworkDevAR/Framework.git"
    }
]

Add the require using the corresponding version:

"require": {
    "frameworkdevar/framework": "dev-main#v0.21.4"
}

Execute the installer:

./vendor/bin/framework install

See Getting Started for the entry point, the .env files and the first build.

The CLI

Command	Does
install	Installs the console command and the phpcs config into the app.
build	Generates the typed code into src/System from the discovered attributes.
destroy	Removes the generated code.
watch	Rebuilds whenever a source file changes.
migrate	Applies the schema and data migrations.
migration	Creates a new data migration with the given title.
ensurePaths	Creates the configured file paths.
icons	Generates the stylesheet and preview page of every icon set.
version	Prints the installed version.

Run ./framework with no arguments to list them with their parameters.