Laravel 6 messenger demo app by Richard Tippin. Working to release this messenger as a package for use with laravel. This is a fully featured stand alone app you can use as a demo or extract my source to fit your needs.
*Please note that until I ready to extract this further into a package, I will be constantly moving items around, and will soon be redoing the entire database structure to utilize more pivots to avoid duplicated data
Checkout the LIVE DEMO
The database and all uploaded files are wiped and reset weekly
- PHP >= 7.2
- REDIS
- Database
- laravel-echo-server tlaverdure/laravel-echo-server
- Models use morphs, able to message between any model using the HasMessenger trait and declare in the messenger config what models and their respective aliases are to be used in your application
- Real-time messaging
- Mobile friendly mode
- Dark Mode
- Messenger inbox is a SPA portal. Page reloads or history state changes are tracked and managed when inside /messenger
- Messenger settings (online/away/offline, accept knocks, sounds, calls from non friends)
- Inactivity status (afk after 10 minutes)
- Group messaging or private messaging (can only have one active private thread between another model at one time, backend checks)
- Upload a profile avatar or a group thread avatar
- Video/Group calling and screen sharing (tracks calls and call participants in DB/Redis)
- Group permissions/admins
- Group invitation links (like discord)
- Live typing and read receipts (bobble heads, similar to hangouts)
- Able to delete private or group threads, or individual messages (if you own them or are admin in a group)
- Uses soft delete, job setup to force delete and remove attachments after 90 days archived
- Thread lockouts
- Messages support emojis, links, youtube, uploaded images or files. You may also drag and drop multiple files into the window at once
- System messages for events like calls, group changes (name, avatar, someone joined or added to group, etc)
- Ghost User model as the default/fallback if a morphs owner is not found (auto-locks private thread in this case)
- Uses ip-api on backend to get IP and timezone, and moment.js on frontend to ensure utc is changed to clients local time
- Friend request / Contacts
- Knock at someone (like a facebook poke to get attention, has a 5 minute lockout)
- Scheduler and jobs that run health checks on calls, group invite expiration's,
- The PushNotificationService is not used right now, but ready to setup and use Google's FCM or Apple's APN push services. You would store a users device ID/TOKEN/VOIP_TOKEN from your mobile app to the user_devices table. Passport can help you achieve this, and I may add that in soon as well
- This demo uses "intervention/image" package to render/orient/cache images, so no need to symlink storage directory to public
- Using my own made js framework, working towards moving to React
- If you use my database seeder, all account passwords are Messenger1!
- Priority account emails are ([email protected], [email protected], [email protected]) that are setup to be friends with everyone, and start message thread with everyone
- All demo accounts are added to a default messenger group thread
In this demo, I use laravel-echo-server, which you should install globally first if you do not already have it
$ npm install -g laravel-echo-serverClone or download this repository
$ git clone [email protected]:RTippin/messenger-demo.gitRun in project:
$ composer installRemove the .example from the .env.example file
Run in project:
$ php artisan key:generate
$ npm installSetup laravel-echo-server first so we can stick all keys we need into the .env at once
Run in project:
$ laravel-echo-server initFollow console setup guide for laravel-echo-server. You should have it setup the appId and key for you. When completed, your project directory should contain a laravel-echo-server.json. Be sure to setup redis port and server for it.
Example:
{
"authHost": "http://localhost:8000",
"authEndpoint": "/broadcasting/auth",
"clients": [
{
"appId": "YOUR_APP_ID",
"key": "YOUR_APP_KEY"
}
],
"database": "redis",
"databaseConfig": {
"redis": {
"port": "6379",
"server": "127.0.0.1"
},
"sqlite": {}
},
"devMode": true,
"host": null,
"port": "6001",
"protocol": "http",
"socketio": {},
"sslCertPath": "",
"sslKeyPath": "",
"sslCertChainPath": "",
"sslPassphrase": "",
"subscribers": {
"http": true,
"redis": true
},
"apiOriginAllow": {
"allowCors": true,
"allowOrigin": "http://localhost:8000",
"allowMethods": "GET, POST",
"allowHeaders": "Origin, Content-Type, X-Auth-Token, X-Requested-With, Accept, Authorization, X-CSRF-TOKEN, X-Socket-Id"
}
}Now copy your laravel-echo-server.json appId / key into the .env MIX_SOCKET_APP_ID / MIX_SOCKET_APP_KEY and update the other SOCKET / MIX_SOCKET values to match your needs
Update the database, redis, mail, recaptcha values to your use case
If you have a pro account from https://ip-api.com/ add your key to the .env IPAPI_KEY
Run in project:
$ php artisan config:cache
$ php artisan migrate:fresh --seedCompile the js/css assets:
$ npm run devTo run locally, run 3 terminals for the following commands in your project for all features minus scheduler:
$ php artisan serve
$ php artisan queue:work
$ laravel-echo-server startFor the auto call health checks/end calls, you will need to setup a cronjob / service worker to run the laravel scheduler
Example:
* * * * * cd /var/www/html && php artisan schedule:run >> /dev/null 2>&1Video calls themselves are tracked on the backend, but use the open WebRTC standard for media streaming amongst peers. I have included some open google stun servers inside my WebRTCManager.js
If you choose to use this outside of demo purposes, I recommend you setup your own Stun/Turn servers
Please note the entire javascript managers/modules in the assets directory are a mini framework of my own making. I am hoping to switch this over to React as we are working towards a mobile app based on React Native
The Laravel framework / Tippin's Messenger demo app is open-sourced software licensed under the MIT license.