2018-11-30 14:07:34 +00:00
# Laravel WebSockets 🛰
2018-11-20 08:54:06 +00:00
[](https://packagist.org/packages/beyondcode/laravel-websockets)
[](https://travis-ci.org/beyondcode/laravel-websockets)
[](https://scrutinizer-ci.com/g/beyondcode/laravel-websockets)
[](https://packagist.org/packages/beyondcode/laravel-websockets)
2018-12-04 19:27:52 +00:00
Bring the power of WebSockets to your Laravel application. Drop-in Pusher replacement, SSL support, Laravel Echo support and a debug dashboard are just some of its features.
2018-11-20 08:54:06 +00:00
## Installation
You can install the package via composer:
```bash
composer require beyondcode/laravel-websockets
```
2018-11-29 16:29:55 +00:00
The package will automatically register a service provider.
2018-11-20 08:54:06 +00:00
## Usage
2018-11-29 16:29:55 +00:00
Once the package is installed, you can publish the configuration file using:
```
php artisan vendor:publish --provider="BeyondCode\LaravelWebSockets\WebSocketsServiceProvider" --tag="config"
2018-11-20 08:54:06 +00:00
```
2018-12-03 08:09:41 +00:00
To start the WebSocket server, use:
2018-11-20 08:54:06 +00:00
```
2018-11-29 16:29:55 +00:00
php artisan websockets:serve
```
2018-12-04 19:25:41 +00:00
For in-depth usage and deployment details, please take a look at the [official documentation ](https://docs.beyondco.de/laravel-websockets/ ).
2018-11-20 08:54:06 +00:00
### Changelog
Please see [CHANGELOG ](CHANGELOG.md ) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING ](CONTRIBUTING.md ) for details.
### Security
If you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker.
## Credits
- [Marcel Pociot ](https://github.com/mpociot )
2018-11-21 23:26:09 +00:00
- [Freek Van der Herten ](https://github.com/freekmurze )
2018-11-20 08:54:06 +00:00
- [All Contributors ](../../contributors )
## License
The MIT License (MIT). Please see [License File ](LICENSE.md ) for more information.
