https://github.com/janyksteenbeek/ban
Ban is an open-source client for Ray, a powerful and easy to use debugging library
https://github.com/janyksteenbeek/ban
ban debug nativephp php
Last synced: 5 days ago
JSON representation
Ban is an open-source client for Ray, a powerful and easy to use debugging library
- Host: GitHub
- URL: https://github.com/janyksteenbeek/ban
- Owner: janyksteenbeek
- License: mit
- Created: 2023-09-22T17:34:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-29T00:44:17.000Z (almost 2 years ago)
- Last Synced: 2026-04-24T17:33:24.045Z (about 2 months ago)
- Topics: ban, debug, nativephp, php
- Language: PHP
- Homepage:
- Size: 216 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
Ban - Debugging Client
[](https://github.com/janyksteenbeek/ban/releases)
[](LICENSE.md)
[](https://github.com/janyksteenbeek/ban/issues)
Ban is an open-source client for Ray, a powerful and easy-to-use debugging [library](https://github.com/spatie/ray). Ban
provides a
user-friendly interface to interact with Ray and visualize debugging data sent from your applications.
- Visualize debugging data in a well-organized and easy-to-navigate interface.
- Support for multiple languages and frameworks, including PHP, JavaScript, Python, and more.
- Display logs, dumps, queries, and other debugging information.
- Easy to use interface with light and dark themes.
## Getting Started
### Prerequisites
- PHP 8.2
- Composer
- Node.js (latest LTS version)
- npm (latest stable version)
### Installation for development
1. Clone the repository:
```bash
git clone git@github.com:janyksteenbeek/ban.git
```
2. Install the dependencies:
```bash
composer install --dev
npm install
php artisan native:migrate
```
3. Run the application:
```bash
php artisan native:serve
```
**The application will now start the underlying API & websocket server running
on [http://localhost:23517/](http://localhost:23517/) and the desktop application automatically open.**
### Usage
To use Ban with your application, you'll need to install the Ray library and integrate it into your project. Follow the
documentation for your specific language or framework:
- [Ray for PHP](https://spatie.be/docs/ray)
- [Ray for JavaScript](https://github.com/permafrost-dev/node-ray)
- [Ray for Python](https://github.com/luetmich/python-ray)
- [Ray for Laravel](https://github.com/spatie/laravel-ray)
Once you've integrated Ray, you can start sending debugging data to the Ban client by following the instructions in the
documentation.
### Example: Using Ban with PHP
To use Ban with your PHP application, you'll need to install the `spatie/ray` package. Follow these steps:
#### Installation
1. Install the `spatie/ray` package using Composer:
```bash
composer require spatie/ray --dev
```
This command will install the Ray package as a development dependency in your project.
#### Usage
2. In your PHP code, use the `ray()` function to send debugging data to the Ban client:
```php