README

Ultra-light, modern PHP framework built for speed, clarity, and extensibility. Inspired by nature. Built for developers. Powered by AI

Feature Docs

Focused package documentation lives next to the relevant source folders:

• Auth
• Cache
• Container
• Console
• Database Overview
• Migrations
• Schema Builder and Reverse Engineering
• Query Builder
• Models
• Events
• HTTP
• Logging
• Mongo
• Middleware
• Queue
• Rate Limiting
• Redis
• Routing
• Storage
• Support and Facades
• Validation

Install via Composer

composer require 200mph/myxa-framework

Docker Setup

The repository includes a PHP 8.4 CLI container plus MySQL, PostgreSQL, Redis, and MongoDB containers for execution-level integration tests.

Install Composer dependencies

docker compose run --rm php composer install

Run unit tests

docker compose run --rm php composer test:unit

Run unit test coverage

The PHP CLI image ships with PCOV, a lightweight code coverage driver.

docker compose build php
docker compose run --rm php composer test:coverage

For an HTML report:

docker compose run --rm php composer test:coverage:html

Start containers

docker compose up -d

Enter running containers

docker exec -it myxa-php-cli /bin/bash
docker exec -it myxa-mysql /bin/bash
docker exec -it myxa-postgres /bin/bash
docker exec -it myxa-mongo /bin/bash

MySQL credentials are loaded from:

• ./docker/mysql/.env

PostgreSQL credentials are loaded from:

• ./docker/postgres/.env

Default host in Docker network:

• mysql
• postgres
• redis
• mongo

Default exposed host port:

• 3306
• 5432
• 6379
• 27017

On Linux/macOS, build the PHP image with your local UID/GID:

UID=$(id -u) GID=$(id -g) docker compose build php