pyaesoneaung / japoe-client
A Self-Hosted Error Tracking Solution for Laravel
Requires
- php: ^8.2
- illuminate/contracts: ^11.0
- spatie/backtrace: ^1.0
- spatie/laravel-package-tools: ^1.0
Requires (Dev)
- larastan/larastan: ^2.9
- laravel/pint: ^1.14
- nunomaduro/collision: ^8.1.1
- orchestra/testbench: ^9.0.0
- pestphp/pest: ^2.34
- pestphp/pest-plugin-arch: ^2.7
- pestphp/pest-plugin-laravel: ^2.3
- phpstan/extension-installer: ^1.3
- phpstan/phpstan-deprecation-rules: ^1.1
- phpstan/phpstan-phpunit: ^1.3
README
This is a client package for JaPoe, a self-hosted error tracking system that allows you to monitor and manage errors.
Requirements
- Laravel >= 11.x
Installation
To start tracking errors with JaPoe Client, follow the steps below:
Step 1: Install JaPoe Client
Use Composer to install the JaPoe Client package:
composer require pyaesoneaung/japoe-client
Step 2: Register JaPoe Client
In bootstrap/app.php
, register the JaPoeClient
to handle exceptions in your application:
->withExceptions(function (Exceptions $exceptions) { \PyaeSoneAung\JaPoeClient\Facades\JaPoeClient::handles($exceptions); })->create();
Step 3: Update Your Environment Configuration
Next, update the .env file with the following configurations:
JAPOE_ENABLE=true JAPOE_HOST=your-japoe-host JAPOE_KEY=your-japoe-key
Make sure to replace your-japoe-host and your-japoe-key with your actual server information and API key.
Step 4: Test JaPoe Client
Once everything is set up, test the JaPoe Client by running:
php artisan japoe:test
If the setup is successful, your Laravel application will now begin tracking errors and sending them to your self-hosted JaPoe server.