The default application template for WebFiori Framework. Use this as a starting point to create new WebFiori projects.
- PHP >= 8.1
- Composer
composer create-project webfiori/app my-site
cd my-site
php -S localhost:8080 -t publicThen open http://localhost:8080 in your browser.
โโโ public/ # Web server document root
โ โโโ index.php # Application entry point
โ โโโ .htaccess # Apache rewrite rules
โ โโโ web.config # IIS rewrite rules
โ โโโ assets/ # Static files (CSS, JS, images)
โโโ tests/ # PHPUnit tests
โ โโโ bootstrap.php # Test bootstrap
โ โโโ phpunit.xml # PHPUnit configuration
โโโ composer.json
โโโ php_cs.php.dist # PHP CS Fixer configuration
โโโ webfiori # CLI entry point (Linux/macOS)
โโโ webfiori.bat # CLI entry point (Windows)
After running composer create-project, the framework will generate an App/ directory containing your application code (routes, middleware, commands, etc.).
By default, the framework uses App/ as the application root directory. To change this, edit the first parameter of App::initiate() in public/index.php:
App::initiate('MyApp', 'public', __DIR__);Reasons you might want to rename it:
- Gives your project a distinct identity instead of a generic
App/folder. - Avoids naming conflicts if you're integrating WebFiori into an existing project that already has an
App/directory. - Makes it easier to distinguish between multiple WebFiori-based projects in the same workspace.
composer testThis project uses PHP CS Fixer for code style enforcement.
composer cs-check # Check for violations (dry run)
composer cs-fix # Auto-fix violationsWebFiori includes a CLI tool for common tasks:
# Linux/macOS
php webfiori
# Windows
webfiori.batFor information on how to contribute, see the contribution guide.
- For bugs and feature requests, open an issue.
- For security vulnerabilities, please email ibrahim@webfiori.com.
This project is licensed under the MIT License.