Configuration
Requirements
- PHP 8.0+
- Composer
Installation
composer require clickfwd/yoyo
How to Set Up Yoyo
- 1
Choose Your Stack
Select your template engine and framework integration. - 2
Configure Paths
Set the URL endpoint, views directory, and other paths. - 3
Install Dependencies
Copy the composer require command and run it in your project. - 4
Add Bootstrap Code
Copy the bootstrap configuration into your application. - 5
Set Up Route Handler
Add the Yoyo route handler to process component updates.
Who Uses This Tool?
1
New Yoyo Projects
Developers setting up Yoyo for the first time who need correct configuration.
2
Template Engine Migration
Developers switching between PHP, Blade, or Twig engines in an existing Yoyo project.
3
Framework Integration
Teams integrating Yoyo into Laravel or vanilla PHP applications.
Why Use the Yoyo Configuration Generator?
Setting up Yoyo requires configuring a view provider, registering routes, and wiring up the AJAX endpoint. The configuration varies significantly between template engines and frameworks. This generator produces the exact setup code you need, reducing setup errors.
The Yoyo Configuration Generator produces complete, copy-paste-ready setup code for the Yoyo PHP framework. It generates installation commands, bootstrap configuration, route handlers, and page templates tailored to your chosen template engine and framework.
How It Compares
Instead of piecing together configuration from the Yoyo README, this generator produces all the setup code in one place, organized in logical tabs. It handles the differences between PHP, Blade, and Twig configurations automatically.
Setup Tips
1
The views directory must exist before Yoyo can render components. 2
For Blade, ensure the cache directory is writable by the web server. 3
The Yoyo URL endpoint must match in both the configuration and your route handler. 4
Use yoyo_scripts() in your page head to load the required JavaScript automatically. Frequently Asked Questions
1
What template engines does Yoyo support?
Yoyo supports three template engines: built-in PHP views, Blade (using jenssegers/blade package, no Laravel required), and Twig.
2
Can I use Yoyo with Laravel?
Yes. When using Laravel, Yoyo configuration is typically placed in a ServiceProvider. This generator creates a ready-to-use YoyoServiceProvider class.
3
What is the Yoyo URL endpoint for?
The URL endpoint is the route that handles AJAX requests from Yoyo components. When a user interacts with a component, Yoyo sends a request to this endpoint to process the update.
4
Do I need to install htmx separately?
No. Yoyo bundles htmx and its own JavaScript. The yoyo_scripts() function outputs the necessary script tags automatically.
5
What PHP version is required?
Yoyo requires PHP 8.0 or higher.