|
| 1 | +<p align="center"> |
| 2 | + <a href="https://github.com/Pollora/framework"> |
| 3 | + <img src="resources/images/pollora-logo.svg" width="400" alt="Pollora"> |
| 4 | + </a> |
| 5 | +</p> |
| 6 | + |
| 7 | +<p align="center"> |
| 8 | + <a href="https://packagist.org/packages/pollora/framework"><img src="https://img.shields.io/packagist/v/pollora/framework" alt="Latest Stable Version"></a> |
| 9 | + <a href="https://packagist.org/packages/pollora/framework"><img src="https://img.shields.io/packagist/dt/pollora/framework" alt="Total Downloads"></a> |
| 10 | + <a href="https://codecov.io/gh/Pollora/framework"><img src="https://codecov.io/gh/Pollora/framework/branch/main/graph/badge.svg" alt="Coverage"></a> |
| 11 | + <a href="https://packagist.org/packages/pollora/framework"><img src="https://img.shields.io/packagist/l/pollora/framework" alt="License"></a> |
| 12 | +</p> |
| 13 | + |
| 14 | +## About Pollora Framework |
| 15 | + |
| 16 | +Pollora is a framework that bridges **Laravel** and **WordPress**, combining Laravel's architecture patterns with WordPress's content management capabilities. It allows developers to use Laravel's service providers, dependency injection, Blade templates, and Eloquent ORM while maintaining full WordPress functionality. |
| 17 | + |
| 18 | +### Key Features |
| 19 | + |
| 20 | +- **WordPress routing** via `Route::wp()` with template hierarchy support |
| 21 | +- **PHP attributes** for hooks (`#[Action]`, `#[Filter]`), post types (`#[PostType]`), taxonomies (`#[Taxonomy]`), scheduling (`#[Schedule]`), and REST routes (`#[WpRestRoute]`) |
| 22 | +- **Auto-discovery system** that scans and registers components automatically |
| 23 | +- **Blade templates** with [Sage Directives](https://log1x.github.io/sage-directives-docs/) for WordPress data |
| 24 | +- **Theme system** with dynamic PSR-4 autoloading, parent/child theme support, and Vite asset management |
| 25 | +- **WordPress authentication** guard and password hashing integration |
| 26 | +- **Event dispatching** for WordPress core, WooCommerce, Gravity Forms, and Yoast SEO |
| 27 | +- **Module system** via [nwidart/laravel-modules](https://github.com/nwidart/laravel-modules) |
| 28 | + |
| 29 | +## Documentation |
| 30 | + |
| 31 | +Full documentation is available at [github.com/Pollora/documentation](https://github.com/Pollora/documentation). |
| 32 | + |
| 33 | +## Installation |
| 34 | + |
| 35 | +Pollora is installed via the [skeleton project](https://github.com/Pollora/pollora): |
| 36 | + |
| 37 | +```bash |
| 38 | +composer create-project pollora/pollora my-project |
| 39 | +``` |
| 40 | + |
| 41 | +See the [skeleton README](https://github.com/Pollora/pollora) for detailed setup instructions. |
| 42 | + |
| 43 | +## Requirements |
| 44 | + |
| 45 | +- PHP ^8.3 |
| 46 | +- Laravel 13.x |
| 47 | +- WordPress 6.9+ |
| 48 | + |
| 49 | +## Testing |
| 50 | + |
| 51 | +```bash |
| 52 | +composer test # Run all checks (Rector, Pint, PHPStan, Pest) |
| 53 | +composer test:unit # Run Pest tests with 100% coverage requirement |
| 54 | +composer test:types # Run PHPStan static analysis |
| 55 | +composer test:lint # Check code style with Pint |
| 56 | +composer test:refacto # Check refactoring rules with Rector |
| 57 | +``` |
| 58 | + |
| 59 | +## Contributing |
| 60 | + |
| 61 | +Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details. |
| 62 | + |
| 63 | +## Security |
| 64 | + |
| 65 | +If you discover a security vulnerability, please report it via [GitHub Security Advisories](https://github.com/Pollora/framework/security/advisories/new). See [SECURITY.md](SECURITY.md) for details. |
| 66 | + |
| 67 | +## Changelog |
| 68 | + |
| 69 | +All notable changes are documented in [CHANGELOG.md](CHANGELOG.md). |
| 70 | + |
| 71 | +## License |
| 72 | + |
| 73 | +Pollora is open-sourced software licensed under the [GPL-2.0-or-later](LICENSE). |
0 commit comments