chappy-php/chappy-php

Starter project for Chappy PHP Framework.

v1.2.4 2025-06-17 22:43 UTC

Requires

• php: >=8.3
• chappy-php/chappy-php-framework: ^1.0

MIT

• Chad Chapman

README

Chappy.php Starter Application

Visit our Wiki

Chappy.php is a lightweight, extensible MVC PHP framework designed for developers who want clarity, power, and flexibility in their projects.

Originally a fork of the Ruah PHP MVC framework inspired by Freeskills’ YouTube series, we've expanded it with modern tools, cleaner structure, and new features.

🚀 Quick Start

1. Install system dependencies:

• PHP 8.3+
• Composer
• npm

1. Create a new project:

composer create-project chappy-php/chappy-php my-app
cd my-app

1. Run the development server:

php console serve

1. Start Vite dev server:

npm run dev

🧰 Features

• ✍️ Custom form handling & validation
• 🧭 Dynamic routing
• 🧪 Unit test support
• 🧑‍💻 User authentication & ACL
• 🔥 Vite-based asset bundling
• 🧱 Layouts, components, and views
• 📊 API docs via Doctum
• 📖 Built-in documentation using Jekyll
• 🎛 Command-line support via Symfony Console
• 📥 Secure file uploads
• 📦 Seeders, migrations, and database helpers

System Requirements

• Apache or Nginx (or XAMPP)
• PHP 8.3
• MySQL or MariaDB
• Composer, Node.js, npm
• SQL Management software
• Composer
• git
• OS: macOS / Linux / Windows 10+

📄 Documentation Full documentation is included with the project. After setup, access:

• 📘 User Guide
• 🔧 API Reference

📬 Contact Questions or suggestions? 📧 [e-mail]. 🐛 Open an issue

🌐 Social Youtube: https://www.youtube.com/@chappy-php

🏆 Credits

1. “mvc” icon by iconixar, from thenounproject.com.
2. Freeskills on YouTube (https://www.youtube.com/playlist?list=PLFPkAJFH7I0keB1qpWk5qVVUYdNLTEUs3)