Feature/live reverb notifications

.env.example

@@ -32,9 +32,11 @@ SESSION_DRIVER=database
 SESSION_LIFETIME=120
 SESSION_ENCRYPT=false
 SESSION_PATH=/
-SESSION_DOMAIN=null
+SESSION_DOMAIN=guacpanel-official.test
+SANCTUM_STATEFUL_DOMAINS=guacpanel-official.test,localhost,127.0.0.1
 
-BROADCAST_CONNECTION=log
+BROADCAST_DRIVER=reverb
+BROADCAST_CONNECTION=reverb
 FILESYSTEM_DISK=local
 QUEUE_CONNECTION=database
 
@@ -91,6 +93,13 @@ APP_DEMO_ENABLED=false
 [email protected]
 APP_DEMO_LOGIN_PASSWORD=password
 
+APP_NOTIFICATIONS_ENABLED=true
+APP_NOTIFICATIONS_IN_DEMO_MODE=true
+APP_NOTIFICATIONS_AUTO_CLEANUP_DELETED_ENABLED=false
+APP_NOTIFICATIONS_AUTO_CLEANUP_DELETED_DAYS=60
+APP_NOTIFICATIONS_AUTO_CLEANUP_SEND_EMAIL=true
+APP_NOTIFICATIONS_AUTO_CLEANUP_SEND_EMAIL_TO="${APP_HELP_EMAIL}"
+
 SEED_SUPER_ADMIN_USER_ENABLED=true
 SEED_SUPER_ADMIN_USER_NAME=Ota
 [email protected]
@@ -130,3 +139,20 @@ LINKEDIN_ENABLED=false
 LINKEDIN_CLIENT_ID=your-linkedin-client-id
 LINKEDIN_SECRET=your-linkedin-client-secret
 LINKEDIN_REDIRECT=${APP_URL}/auth/social/linkedin/callback
+
+REVERB_APP_ID=
+REVERB_APP_KEY=
+REVERB_APP_SECRET=
+REVERB_HOST="localhost"
+REVERB_PORT=8080
+REVERB_SCHEME=https
+REVERB_SERVER_HOST=0.0.0.0
+REVERB_SERVER_PORT=8080
+REVERB_TLS_CERT=
+REVERB_TLS_KEY=
+
+VITE_REVERB_APP_KEY="${REVERB_APP_KEY}"
+VITE_REVERB_HOST="${REVERB_HOST}"
+VITE_REVERB_PORT="${REVERB_PORT}"
+VITE_REVERB_SCHEME="${REVERB_SCHEME}"
+VITE_APP_NOTIFICATIONS_ENABLED="${APP_NOTIFICATIONS_ENABLED}"

README.md

@@ -24,65 +24,69 @@ An opinionated Laravel starter kit built with Vue.js, Inertia.js, and Tailwind C
   </tr>
 </table>
 
-
 ## Features
 
 - 🔐 **Authentication & Security**
-  - Secure login with [Laravel Fortify](https://laravel.com/docs/fortify)
-  - Passwordless magic link authentication
-  - Social Authentication with [Laravel Socialite](https://laravel.com/docs/socialite)
-    - [Google](https://console.developers.google.com/)
-    - [GitHub](https://github.com/settings/applications/new) (Will work with local dev callback)
-    - [Facebook](https://developers.facebook.com/) (Will work with local dev callback)
-    - [LinkedIn](https://www.linkedin.com/developers/apps/) (Will work with local dev callback)
-  - Two-factor authentication (2FA) via [Laravel Fortify](https://laravel.com/docs/fortify#two-factor-authentication)
-  - Role-based permissions with [Spatie Permission](https://spatie.be/docs/laravel-permission)
-    - Visual role and permission management
-    - User role assignment interface
-  - Session and security management
-    - Active sessions overview
-    - Login history tracking
-    - Password policies enforcement
+    - Secure login with [Laravel Fortify](https://laravel.com/docs/fortify)
+    - Passwordless magic link authentication
+    - Social Authentication with [Laravel Socialite](https://laravel.com/docs/socialite)
+        - [Google](https://console.developers.google.com/)
+        - [GitHub](https://github.com/settings/applications/new) (Will work with local dev callback)
+        - [Facebook](https://developers.facebook.com/) (Will work with local dev callback)
+        - [LinkedIn](https://www.linkedin.com/developers/apps/) (Will work with local dev callback)
+    - Two-factor authentication (2FA) via [Laravel Fortify](https://laravel.com/docs/fortify#two-factor-authentication)
+    - Role-based permissions with [Spatie Permission](https://spatie.be/docs/laravel-permission)
+        - Visual role and permission management
+        - User role assignment interface
+    - Session and security management
+        - Active sessions overview
+        - Login history tracking
+        - Password policies enforcement
 
 - 🎨 **Interface & Design**
-  - Dark/Light mode with system preference detection
-  - Responsive design with [Tailwind CSS v4](https://tailwindcss.com/docs)
-  - Auto-generated avatars via [Laravel Avatar](https://github.com/laravolt/avatar)
-  - Local Google Fonts via [Spatie Laravel Google Fonts](https://github.com/spatie/laravel-google-fonts)
-  - Customizable theme settings
+    - Dark/Light mode with system preference detection
+    - Responsive design with [Tailwind CSS v4](https://tailwindcss.com/docs)
+    - Auto-generated avatars via [Laravel Avatar](https://github.com/laravolt/avatar)
+    - Local Google Fonts via [Spatie Laravel Google Fonts](https://github.com/spatie/laravel-google-fonts)
+    - Customizable theme settings
 
 - 📊 **Data Visualization**
-  - Interactive charts with [ApexCharts v3](https://apexcharts.com)
-    - Line, Area, Bar, and Donut charts
-    - Responsive and mobile-friendly
-    - Export capabilities
-  - Automatic data formatting
-  - Dynamic chart resizing
+    - Interactive charts with [ApexCharts v3](https://apexcharts.com)
+        - Line, Area, Bar, and Donut charts
+        - Responsive and mobile-friendly
+        - Export capabilities
+    - Automatic data formatting
+    - Dynamic chart resizing
 
 - 📊 **Data Tables**
-  - Modern tables with [@tanstack/vue-table v8](https://tanstack.com/table/v8/docs)
-    - Server-side pagination
-    - Column sorting
-    - Search functionality
-  - Data export with [Laravel Excel](https://docs.laravel-excel.com)
-  - Action buttons with confirmation dialogs
+    - Modern tables with [@tanstack/vue-table v8](https://tanstack.com/table/v8/docs)
+        - Server-side pagination
+        - Column sorting
+        - Search functionality
+    - Data export with [Laravel Excel](https://docs.laravel-excel.com)
+    - Action buttons with confirmation dialogs
 
 - 📁 **File Management**
-  - Drag & drop uploads with [FilePond v4](https://pqina.nl/filepond/docs/)
-    - Image preview
-    - File type validation
-    - Size restrictions
-  - Multiple file selection
+    - Drag & drop uploads with [FilePond v4](https://pqina.nl/filepond/docs/)
+        - Image preview
+        - File type validation
+        - Size restrictions
+    - Multiple file selection
 
 - 🔄 **System Features**
-  - Backup management via [Spatie Backup](https://spatie.be/docs/laravel-backup)
-    - User-friendly dashboard
-    - One-click backup creation
-    - Backup download
-  - Activity logging with [Laravel Auditing](https://laravel-auditing.com)
-    - User action tracking
-    - Data change history
-  - Security event monitoring
+    - Backup management via [Spatie Backup](https://spatie.be/docs/laravel-backup)
+        - User-friendly dashboard
+        - One-click backup creation
+        - Backup download
+    - Activity logging with [Laravel Auditing](https://laravel-auditing.com)
+        - User action tracking
+        - Data change history
+    - Security event monitoring
+
+- 🔔 **Real-time Notifications (Laravel Reverb)**
+    - Live, in-app notifications via WebSockets (Reverb)
+    - Demo mode toggle via `APP_NOTIFICATIONS_IN_DEMO_MODE`
+    - Run locally with `php artisan reverb:start`
 
 ## Quick Start
 
@@ -95,24 +99,28 @@ An opinionated Laravel starter kit built with Vue.js, Inertia.js, and Tailwind C
 ### Installation
 
 1. Clone the repository
+
 ```bash
 git clone https://github.com/otatechie/guacpanel-tailwind.git
 cd guacpanel-tailwind
 ```
 
 2. Install dependencies
+
 ```bash
 composer install
 npm install
 ```
 
 3. Set up environment
+
 ```bash
 cp .env.example .env
 php artisan key:generate
 ```
 
 4. Configure your database in `.env`
+
 ```
 DB_CONNECTION=mysql
 DB_HOST=127.0.0.1
@@ -123,17 +131,59 @@ DB_PASSWORD=your_password
 ```
 
 5. Run migrations and seed
+
 ```bash
 php artisan migrate
 php artisan db:seed
 ```
 
 6. Start development servers
+
 ```bash
 npm run dev
 php artisan serve
 ```
 
+### Real-time Notifications (Laravel Reverb)
+
+GuacPanel ships with an optional real-time notifications system powered by **Laravel Reverb** (WebSockets).
+
+1. Enable notifications in `.env`
+
+```dotenv
+APP_NOTIFICATIONS_ENABLED=true
+APP_NOTIFICATIONS_IN_DEMO_MODE=true # set this to false to enable live reverb notifications.
+```
+
+2. Install broadcasting + Reverb (generates credentials)
+
+```bash
+php artisan install:broadcasting
+```
+
+This will populate the following in your `.env` (you can override these as needed):
+
+```dotenv
+REVERB_APP_ID=
+REVERB_APP_KEY=
+REVERB_APP_SECRET=
+REVERB_HOST="localhost"
+REVERB_PORT=8080
+REVERB_SCHEME=https
+REVERB_SERVER_HOST=0.0.0.0
+REVERB_SERVER_PORT=8080
+REVERB_TLS_CERT=
+REVERB_TLS_KEY=
+```
+
+3. Start the Reverb server (separate terminal)
+
+```bash
+php artisan reverb:start
+```
+
+> If you're using Herd / Valet secure domains, you can point `REVERB_TLS_CERT` and `REVERB_TLS_KEY` at the generated certificate + key to use `wss://` in local development.
+
 **🎉 That's it!** Visit `http://localhost:8000` to see the app in action.
 
 **🔗 External Resources**

app/Console/Commands/CleanupDeletedAppNotificationsCommand.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Services\Notifications\AppNotificationCleanupService;
+use Illuminate\Console\Command;
+
+class CleanupDeletedAppNotificationsCommand extends Command
+{
+    protected $signature = 'notifications:cleanup-deleted {days? : Days since deleted_at to permanently delete}';
+
+    protected $description = 'Permanently deletes soft-deleted app notifications older than N days.';
+
+    public function handle(AppNotificationCleanupService $cleanup): int
+    {
+        $days = $this->argument('days');
+
+        if ($days === null || $days === '') {
+            $days = (int) config('guacpanel.notifications.auto_cleanup_deleted_days', 30);
+        }
+
+        $days = max(1, (int) $days);
+
+        $result = $cleanup->cleanupDeleted($days);
+
+        $this->info('Deleted notifications: '.$result['deleted']);
+        $this->info('Cutoff date: '.$result['cutoff']->toDateTimeString().' ('.$result['days'].' days)');
+
+        return self::SUCCESS;
+    }
+}

app/Console/Commands/SendScheduledAppNotificationsCommand.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Services\Notifications\AppNotificationScheduledSendService;
+use Illuminate\Console\Command;
+
+class SendScheduledAppNotificationsCommand extends Command
+{
+    protected $signature = 'notifications:send-scheduled {--dry-run : Do not dispatch events or update sent_as_scheduled}';
+
+    protected $description = 'Send scheduled notifications that are due (scheduled_on passed, not sent_as_scheduled, not deleted, not expired).';
+
+    public function handle(AppNotificationScheduledSendService $service): int
+    {
+        $dryRun = (bool) $this->option('dry-run');
+
+        $count = $service->sendDue($dryRun);
+
+        if ($dryRun) {
+            $this->info("Dry run: {$count} scheduled notifications are due.");
+
+            return self::SUCCESS;
+        }
+
+        $this->info("Sent {$count} scheduled notifications.");
+
+        return self::SUCCESS;
+    }
+}

app/Console/Commands/SoftDeleteExpiredAppNotificationsCommand.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Services\Notifications\AppNotificationAutoExpireService;
+use Illuminate\Console\Command;
+
+class SoftDeleteExpiredAppNotificationsCommand extends Command
+{
+    protected $signature = 'notifications:soft-delete-expired';
+
+    protected $description = 'Soft deletes app notifications whose auto_expire_on is set and has passed.';
+
+    public function handle(AppNotificationAutoExpireService $service): int
+    {
+        $result = $service->softDeleteExpired();
+
+        $this->info('Soft-deleted notifications: '.$result['soft_deleted']);
+        $this->info('Cutoff (now): '.$result['cutoff']->toDateTimeString());
+
+        return self::SUCCESS;
+    }
+}

app/Events/AppNotificationCreated.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\AppNotification;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PrivateChannel;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcastNow;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class AppNotificationCreated implements ShouldBroadcastNow
+{
+    use Dispatchable;
+    use InteractsWithSockets;
+    use SerializesModels;
+
+    public function __construct(public AppNotification $notification)
+    {
+    }
+
+    public function broadcastOn(): Channel
+    {
+        if ($this->notification->scope === 'system' || $this->notification->scope === 'release') {
+            return new PrivateChannel('system');
+        }
+
+        return new PrivateChannel('users.'.$this->notification->user_id);
+    }
+
+    public function broadcastAs(): string
+    {
+        return 'app-notification.created';
+    }
+
+    public function broadcastWith(): array
+    {
+        $readAt = null;
+
+        return [
+            'id'         => $this->notification->id,
+            'user_id'    => $this->notification->user_id,
+            'scope'      => $this->notification->scope,
+            'type'       => $this->notification->type,
+            'title'      => $this->notification->title,
+            'message'    => $this->notification->message,
+            'data'       => $this->notification->data,
+            'read_at'    => $readAt,
+            'created_at' => optional($this->notification->created_at)?->toISOString(),
+        ];
+    }
+}