A beautiful error page for PHP applications.
spatie/ignition stats
- Downloads
- 37.8M
- Stars
- 329
- Open Issues
- 100
- Forks
- 45
Ignition by Spatie: Enhanced Error Pages for PHP Applications
Ignition is a visually appealing error page package for PHP applications, designed to make debugging more intuitive and less disruptive. Tailored to improve error handling, it transforms traditional error outputs into more informative and easier-to-read displays.
Key Features:
- Customizable Appearance: Choose between a light or dark theme to suit your preferences or ambient lighting conditions.
- Solution Suggestions: Ignition offers potential solutions to common errors directly on the error page, reducing development time.
- Integration with OpenAI: Utilizes AI to suggest solutions for exceptions, enhancing the debugging process with automated insights.
- Flare Integration: Errors can be sent to Flare, a service for monitoring exceptions in production, providing real-time alerts and analytics.
- Environment-Sensitive Display: Configure Ignition to only show detailed error pages in development environments to protect sensitive data in production.
- Extensible: Developers can add custom solution providers or modify the data sent to Flare, allowing for a tailored error handling experience.
Installation:
For non-Laravel PHP projects:
composer require spatie/ignition
For Laravel and Symfony, specific packages like laravel-ignition
and symfony-ignition-bundle
are recommended.
Basic Usage:
To register Ignition in your PHP application:
\Spatie\Ignition\Ignition::make()->register();
Additional configurations like setting the application path, opting for dark mode, and configuring exception display conditions can enhance the setup.
Advanced Features:
- AI-Powered Solutions: After installing
openai-php/client
, Ignition can suggest solutions based on AI analysis. - Custom Solutions: Implement
ProvidesSolution
interface on exceptions to return custom solutions. - Error Reporting to Flare: Configure Ignition to send exceptions to Flare with detailed context or custom filters.
- Middleware for Data Modification: Before sending data to Flare, modify it using custom middleware for additional insights or privacy.
Developer Resources:
- Community Contributions: Contributions are welcome; see the CONTRIBUTING guide for more details.
- Security: Report security vulnerabilities as per the project's security policy.
Ignition, licensed under MIT, is part of Spatie’s commitment to the open-source community, enhancing developer productivity and error management in PHP applications.