multimedia-street / forever
Forever broadcasting <3
Requires
- php: ~5.5|~7.0
- illuminate/broadcasting: >=5.1
- illuminate/console: >=5.1
- illuminate/support: >=5.1
- illuminate/view: >=5.1
Requires (Dev)
- phpunit/phpunit: 4.*
- scrutinizer/ocular: ~1.1
- squizlabs/php_codesniffer: ~2.3
This package is not auto-updated.
Last update: 2021-03-28 06:25:08 UTC
README
Forever broadcasting.
Install
NPM
Add the required Nodejs Packages.
npm install --save forever ioredis socket.io
Via Composer
Require the multimedia-street/forever package in your composer.json and update your dependencies.
$ composer require multimedia-street/forever
Add Service Provider
Include the Service Provider to your config/app.php in providers array
Mmstreet\Forever\ServiceProvider::class,
Optional Publish Configuration
You can publish the configuration.
$ php artisan vendor:publish --provider="Mmstreet\Forever\ServiceProvider"
This will create config/forever.php.
port
Port number for forever listen. Default 3000
channel
Channel of the forever. This will be added on broadcastOn() array of your events, if your events implements the interface ShouldBroadcast. Default global.
Commands
Example usage
$ php artisan forever:start
forever:generate
Generate a forever.js file to your base app.
forever:start
Start the forever service. This also generate a forever.js
forever:stop [-c|--clear]
Stop the forever service. Option --clear will also delete the logs afterwards, this is only calling the forever:clear
forever:clear
Clear the forever logs.
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email :author_email instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.