{"id":19845296,"url":"https://github.com/janyksteenbeek/ban","last_synced_at":"2026-06-10T12:31:11.389Z","repository":{"id":198956109,"uuid":"695252699","full_name":"janyksteenbeek/ban","owner":"janyksteenbeek","description":"Ban is an open-source client for Ray, a powerful and easy to use debugging library","archived":false,"fork":false,"pushed_at":"2024-06-29T00:44:17.000Z","size":221,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-24T17:33:24.045Z","etag":null,"topics":["ban","debug","nativephp","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/janyksteenbeek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"janyksteenbeek"}},"created_at":"2023-09-22T17:34:31.000Z","updated_at":"2024-08-13T12:09:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"94d9ce82-30d2-4146-be94-79bca3bdabe1","html_url":"https://github.com/janyksteenbeek/ban","commit_stats":null,"previous_names":["janyksteenbeek/ban"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/janyksteenbeek/ban","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janyksteenbeek%2Fban","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janyksteenbeek%2Fban/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janyksteenbeek%2Fban/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janyksteenbeek%2Fban/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/janyksteenbeek","download_url":"https://codeload.github.com/janyksteenbeek/ban/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/janyksteenbeek%2Fban/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34153482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ban","debug","nativephp","php"],"created_at":"2024-11-12T13:07:07.319Z","updated_at":"2026-06-10T12:31:11.365Z","avatar_url":"https://github.com/janyksteenbeek.png","language":"PHP","funding_links":["https://github.com/sponsors/janyksteenbeek"],"categories":[],"sub_categories":[],"readme":"\u003ccenter\u003e\u003cH1\u003eBan - Debugging Client\u003c/H1\u003e\u003c/center\u003e\n\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/janyksteenbeek/ban)](https://github.com/janyksteenbeek/ban/releases)\n[![GitHub](https://img.shields.io/github/license/janyksteenbeek/ban)](LICENSE.md)\n[![GitHub issues](https://img.shields.io/github/issues/janyksteenbeek/ban)](https://github.com/janyksteenbeek/ban/issues)\n\nBan is an open-source client for Ray, a powerful and easy-to-use debugging [library](https://github.com/spatie/ray). Ban\nprovides a\nuser-friendly interface to interact with Ray and visualize debugging data sent from your applications.\n\n- Visualize debugging data in a well-organized and easy-to-navigate interface.\n- Support for multiple languages and frameworks, including PHP, JavaScript, Python, and more.\n- Display logs, dumps, queries, and other debugging information.\n- Easy to use interface with light and dark themes.\n\n## Getting Started\n\n### Prerequisites\n\n- PHP 8.2\n- Composer\n- Node.js (latest LTS version)\n- npm (latest stable version)\n\n### Installation for development\n\n1. Clone the repository:\n\n```bash\ngit clone git@github.com:janyksteenbeek/ban.git\n```\n\n2. Install the dependencies:\n\n```bash\ncomposer install --dev\nnpm install\nphp artisan native:migrate\n```\n\n3. Run the application:\n\n```bash\nphp artisan native:serve\n```\n\n**The application will now start the underlying API \u0026 websocket server running\non [http://localhost:23517/](http://localhost:23517/) and the desktop application automatically open.**\n\n### Usage\n\nTo use Ban with your application, you'll need to install the Ray library and integrate it into your project. Follow the\ndocumentation for your specific language or framework:\n\n- [Ray for PHP](https://spatie.be/docs/ray)\n- [Ray for JavaScript](https://github.com/permafrost-dev/node-ray)\n- [Ray for Python](https://github.com/luetmich/python-ray)\n- [Ray for Laravel](https://github.com/spatie/laravel-ray)\n\nOnce you've integrated Ray, you can start sending debugging data to the Ban client by following the instructions in the\ndocumentation.\n\n### Example: Using Ban with PHP\n\nTo use Ban with your PHP application, you'll need to install the `spatie/ray` package. Follow these steps:\n\n#### Installation\n\n1. Install the `spatie/ray` package using Composer:\n\n```bash\ncomposer require spatie/ray --dev\n```\n\nThis command will install the Ray package as a development dependency in your project.\n\n#### Usage\n\n2. In your PHP code, use the `ray()` function to send debugging data to the Ban client:\n\n```php\n\u003c?php\n\nrequire_once 'vendor/autoload.php';\n\nray('Hello, Ban!');\n\n// Your application code...\n```\n\nThis code will send the message `Hello, Ban!` to the Ban client. You can now use the `ray()` function to send various\ntypes of debugging data, such as variables, objects, and queries, to the Ban client.\n\nFor more information on the `spatie/ray` package and its usage, refer to\nthe [official Ray documentation](https://spatie.be/docs/ray).\n\nOnce you've integrated Ray into your PHP application, you'll be able to send debugging data to the Ban client, where\nyou can analyze and inspect it in a user-friendly interface.\n\n## License\n\nBan is released under the MIT License. See the [LICENSE](LICENSE) file for more details.\n\n## Security\n\nIf you discover any security-related issues, please email [ban@janyk.dev](mailto:ban@janyk.dev) instead of using the\nissue tracker. All security vulnerabilities will be promptly addressed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjanyksteenbeek%2Fban","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjanyksteenbeek%2Fban","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjanyksteenbeek%2Fban/lists"}