README

🧱 Beauty Framework

Beauty is a blazing-fast, PSR-compliant, modular microframework for building REST and gRPC APIs on top of RoadRunner. It provides first-class support for clean architecture, strong developer ergonomics, and production-ready features without FPM overhead. This skeleton is ideal for building microservices, APIs, and gRPC services with Modular Architecture.

🎯 Goals

Beauty is designed as a lightweight, modular and fast foundation for building microservices:

• 🧩 Package-oriented: each module is self-contained and reusable
• 🚀 RoadRunner-native: zero FPM, ultra-low latency
• ⚙️ Clean architecture: clear separation between application layers
• 🧪 Testing-friendly: services are testable by design
• 🐳 Docker-first: fully containerized by default
• 📦 Modularity: easy to extend

🚀 Features

• Fully PSR-compliant (PSR-3, 4, 7, 11, 15, 14)
• Built-in DI container (PHP-DI powered)
• Attribute-based routing and middleware
• Event system with listener registry
• Lightweight config and cache system
• Jobs, events, queues (via RoadRunner)
• Console kernel for CLI tools
• Powered by RoadRunner — no FPM
• Modular architecture

🗂 Project Structure

├── app
│   ├── Console               # CLI commands
│   └── Container             # DI bindings for core services      
├── modules
│   └── hello                 # Example module
│       ├── composer.json     # Module metadata
│       └── src
│           ├── Container     # Module-specific DI bindings
│           ├── Controllers   # HTTP/API controllers
│           ├── Events        # Application events
│           ├── Jobs          # Async jobs
│           ├── Listeners     # Event listeners
│           ├── Middlewares   # PSR-15 middleware
│           ├── Repositories  # Data access
│           ├── Requests      # Validated requests
│           ├── Responses     # Typed responses
│           └── Services      # Business logic
├── config                    # Configuration files
├── workers                   # RoadRunner workers (http, jobs, etc)
├── bootstrap                 # Kernel bootstrapping
├── public/index.php          # Entry point (optional)

📦 Installation

composer create-project beauty-framework/module-app beauty-framework
cd beauty-framework
cp .env.example .env
make up # or make prod

⚙️ Configuration (.env)

APP_NAME=Beauty
APP_ENV=local
APP_VERSION=1.0
APP_TIMEZONE=UTC
APP_LOCALE=en
APP_DEBUG=true
USE_DI_CACHE=true

DB_CONNECTION=pgsql
DB_HOST=database
DB_PORT=5432
DB_DATABASE=my_db
DB_USERNAME=root
DB_PASSWORD=password

CACHE_DRIVER=redis

REDIS_HOST=redis
REDIS_PORT=6379

🧠 CLI Commands

🐳 Docker Setup (default)

Beauty is designed to run natively inside Docker. By default, all services are containerized:

services:
  app:
    build:
      target: dev
    environment:
      PHP_IDE_CONFIG: "serverName=stage"
    restart: unless-stopped

  db:
    image: postgres:16
    ports:
      - "5432:5432"

  redis:
    image: redis:alpine
    ports:
      - "6379:6379"

🛠 Makefile Commands

📚 Documentation

See Documentation page

📦 Related Modules

See full list of modules at Documentation page.

📝 TODO

• ORM support (query builder + migrations)
• beauty/testing package with framework-aware test harness
• gRPC server module with RoadRunner integration
• Job retries, delays, and failure handlers
• OpenAPI/Swagger support
• Full module documentation

Welcome to Beauty Framework — lean, fast, clean. Let's build some serious APIs ⚡