spinxphp/spinx

The official application skeleton for the Spinx PHP Framework.

v1.0.0 2026-08-27 21:25 UTC

Requires

• php: >=8.2
• spinxphp/framework: ^1.0

Requires (Dev)

• fakerphp/faker: ^1.23
• phpstan/phpstan: ^1.11 || ^2.0

Suggests

• ext-swoole: Enables the high-performance Swoole runtime driver (opt-in, Docker/Linux only — see spinx.json "driver": "swoole").

MIT

• iamdevroyal

• framework
• php
• ddd
• react
• openapi
• swoole
• Coroutines
• vue
• domain-driven-design
• roadrunner
• spinx
• islands
• persistent-workers

Published on Packagist.org on 2026-08-27 21:39 UTC

README

The official starter application template for the Spinx PHP Framework.

⚡ Quickstart

Creating a New Project

The recommended way to start a new Spinx project is with the official global installer:

composer global require spinxphp/installer
spinx new my-app

Or directly via Composer:

composer create-project spinxphp/spinx my-app

Starting the Development Server

cd my-app
php spinx serve

Your application is now running at http://localhost:8080 (RoadRunner worker) and the Vite HMR dev server is live at http://localhost:5173.

🧩 Directory Structure

my-app/
├── app/
│   └── Modules/          <-- Domain-Driven Design (DDD) business modules
├── config/               <-- Application configuration (.env backed)
├── frontend/             <-- Vue 3 / React 19 island components (Vite)
├── public/               <-- Web server entry points (index.php, swoole-worker.php)
├── resources/            <-- Views and server-rendered .spinx.html templates
├── storage/              <-- Framework caches, sessions, logs, SQLite DB
├── vendor/
│   └── spinxphp/
│       └── framework/    <-- Spinx Core Engine
├── .env.example
├── .rr.yaml
├── composer.json
└── spinx                 <-- Local CLI development tool

🛠️ Local CLI Commands

php spinx serve                        # Start persistent runtime + Vite HMR
php spinx make:module Orders --all     # Scaffold complete DDD module
php spinx migrate                      # Run database migrations
php spinx queue:work                   # Start background queue worker
php spinx ai:build "Build a CMS"       # Autonomous AI feature build
php spinx driver:swap swoole           # Switch runtime to Swoole coroutines

📖 Documentation

Full guides and API reference: spinxphp.pages.dev/docs

📄 License

MIT — see LICENSE.