README

Green is a lightweight, modern PHP framework built with PHP 8.2+ features, focusing on simplicity, speed, and developer experience. It leverages PHP Attributes for routing and follows a Table Gateway architecture.

Note: This repository contains the application skeleton. The core framework engine is located at YasserElgammal/green-core.

⚡ Quick Start

1. Installation

composer create-project yasser-elgammal/green app-name
cd app-name
cp .env.example .env
php green serve

2. Define a Route

class PostController {
    #[Route('GET', '/posts/{id}', middleware: [AuthMiddleware::class, LocaleMiddleware::class])]
    public function show(int $id) {
        return view('posts/show', ['id' => $id]);
    }
}

Pass route middleware as an array; add multiple middleware classes in the order they should run.

3. Database Access

$posts = new PostTable();
$post  = $posts->fetchById(1);

📖 Master Documentation

The framework is divided into several powerful subsystems. Please refer to the Master Documentation for detailed guides on:

Core Architecture: Lifecycle and DI patterns.
Routing & Middleware: Attribute-based routing and pipelines.
Database & Relations: Eager loading and Table Gateways.
API Layer: Smart Transformers and Pagination.
Logic & Validation: Payload-based validation.
Security & Sessions: State management and hashing.
Global Exception Handling: Debug Mode and API errors.
Helper Reference: Glossary of global functions.
Console Commands: CLI tools and generators.
Migrations & Schema Builder: Migration workflow, schema operations, dry-run mode, and safe mode.
Translation & Localization: Global helpers, multiple providers, caching, and pluralization.
Include Query Language: Advanced relation loading with limits, ordering, filtering, and column selection.
Connect: Outgoing HTTP requests for third-party APIs and services.

🛠 Features at a Glance

✅ PHP 8.2+ Attributes: No more clunky routing files.
✅ Table Gateway: Clean separation of state (Model) and logic (Table).
✅ Eager Loading & IQL: Simple include('relation') to solve N+1, with an advanced query language for limits, ordering, filtering, and column selection.
✅ Smart Transformers: Nested API responses made easy.
✅ Auto-Validation: Type-hint payloads for instant validation.
✅ Twig Templates: Native Twig integration for clean views.
✅ Connect: Simple outgoing HTTP requests for payments, CRMs, messaging APIs, and other services.
✅ Debug UI: Premium dark-mode error pages.

📜 License

Green Framework is open-sourced under the MIT License.

yasser-elgammal / green

Maintainers

Package info

Statistics

Security