Merge branch 'main' of https://github.com/mastashake08/laravel-webrtc

Author: mastashake08

README.md

@@ -1,66 +1,108 @@
-<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
+# Laravel WebRTC with Reverb & Echo
 
-<p align="center">
-<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
-</p>
+This project integrates WebRTC with Laravel Reverb and Laravel Echo, enabling real-time peer-to-peer communication using Laravel’s native WebSocket capabilities.
 
-## Laravel Echo WebRTC Demo
+## Features
+	•	Real-Time Communication: Uses WebRTC for live audio and video calls.
+	•	WebSockets with Laravel Reverb: Provides scalable and low-latency signaling for WebRTC.
+	•	Laravel Echo Integration: Handles WebSocket events seamlessly.
+	•	Vue.js Frontend: A dynamic and interactive UI built with Vue.js.
+	•	Self-Hosted WebSocket Server: No need for third-party WebSocket services.
 
-This repo utilizes Laravel Echo to build a signaling server for WebRTC requests.
+## Prerequisites
+	•	PHP 8+
+	•	Laravel 10+
+	•	Composer
+	•	Node.js & npm
+	•	SQLite, MySQL, or PostgreSQL
 
-- [Simple, fast routing engine](https://laravel.com/docs/routing).
-- [Powerful dependency injection container](https://laravel.com/docs/container).
-- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
-- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
-- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
-- [Robust background job processing](https://laravel.com/docs/queues).
-- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+Installation
+	1.	Clone the Repository:
 
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
+git clone https://github.com/mastashake08/laravel-webrtc.git
+cd laravel-webrtc
 
-## Learning Laravel
 
-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
+	2.	Install Dependencies:
 
-You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
+composer install
+npm install
 
-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
 
-## Laravel Sponsors
+	3.	Environment Configuration:
+	•	Duplicate .env.example and rename it to .env.
+	•	Update your database settings.
+	•	Set the WebSockets connection driver:
 
-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
+BROADCAST_DRIVER=pusher
+PUSHER_APP_ID=reverb
+PUSHER_APP_KEY=reverb
+PUSHER_APP_SECRET=reverb
 
-### Premium Partners
 
-- **[Vehikl](https://vehikl.com/)**
-- **[Tighten Co.](https://tighten.co)**
-- **[WebReinvent](https://webreinvent.com/)**
-- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
-- **[64 Robots](https://64robots.com)**
-- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
-- **[Cyber-Duck](https://cyber-duck.co.uk)**
-- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
-- **[Jump24](https://jump24.co.uk)**
-- **[Redberry](https://redberry.international/laravel/)**
-- **[Active Logic](https://activelogic.com)**
-- **[byte5](https://byte5.de)**
-- **[OP.GG](https://op.gg)**
+	•	Generate an application key:
 
-## Contributing
+php artisan key:generate
 
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
 
-## Code of Conduct
+	4.	Run Database Migrations:
 
-In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
+php artisan migrate
 
-## Security Vulnerabilities
 
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
+	5.	Start Laravel Reverb (WebSocket Server):
 
-## License
+php artisan reverb:start
 
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+
+	6.	Start the Laravel Application:
+
+php artisan serve
+
+
+	7.	Compile Frontend Assets:
+
+npm run dev
+
+Or for production:
+
+npm run build
+
+
+
+WebRTC Signaling Flow
+	1.	User joins a call → Laravel Echo broadcasts an event via Reverb.
+	2.	New peer detected → WebRTC initiates a peer-to-peer connection.
+	3.	ICE Candidates exchanged → STUN/TURN servers handle NAT traversal.
+	4.	Media streams established → Users can see and hear each other.
+
+Configuration for Laravel Echo
+
+Your resources/js/bootstrap.js should have the following:
+
+import Echo from 'laravel-echo';
+
+window.Pusher = require('pusher-js');
+
+window.Echo = new Echo({
+    broadcaster: 'pusher',
+    key: 'reverb',
+    wsHost: window.location.hostname,
+    wsPort: 6001,
+    forceTLS: false,
+    disableStats: true,
+});
+
+Usage
+	1.	Open two different browser windows (or devices).
+	2.	Start a call and invite the other participant.
+	3.	Laravel Reverb will handle WebSocket signaling.
+	4.	WebRTC will establish the peer-to-peer connection.
+
+Contributing
+
+Contributions are welcome! Please fork the repo and submit a pull request.
+
+License
+
+This project is open-source under the MIT License.