feat: Integrate WorkOS for SSO and OAuth flows, update configuration and routes

Author: SamuelBisberg

.env.example

@@ -76,3 +76,9 @@ VITE_APP_NAME="${APP_NAME}"
 # Debugbar configuration 
 DEBUGBAR_ENABLED=true
 DEBUGBAR_EDITOR=vscode-remote
+
+# WorkOS configuration
+WORKOS_ENABLED=false
+WORKOS_API_KEY=
+WORKOS_CLIENT_ID=
+WORKOS_REDIRECT_URI=${APP_URL}/authenticate

README.md

@@ -10,6 +10,7 @@ This is a fork of the [Laravel + React Starter Kit](https://github.com/laravel/r
 - **MinIO & Media Library**: For file uploads and media management.
 - **Sail Included**: Docker support with Laravel Sail for easy local development.
 - **Blueprint**: Uses [laravel-shift/blueprint](https://blueprint.laravelshift.com/) for rapid application development.
+- **Workos**: Integrated for SSO and OAuth flows with [workos.com](https://workos.com).
 
 And much more!
 
@@ -183,3 +184,18 @@ You have Laravels's additional types such as `Paginator`, `EnumTtait` with usefu
 In addition to the default validation rules, We have added the following custom validation rule:
 
 - **Phone**: Validates that the input is a valid phone number using the package [propaganistas/laravel-phone](https://github.com/propaganistas/laravel-phone).
+
+## Workos
+
+The application integrates with [WorkOS](https://workos.com) for SSO and OAuth flows. You ca anable it in the `.env` file:
+
+```env
+WORKOS_ENABLED=true
+WORKOS_CLIENT_ID=your-client-id
+WORKOS_CLIENT_SECRET=your-client-secret
+```
+
+*Note:* Make Sure to set redirect URIs in your WorkOS dashboard to match your application URLs.
+
+- *Redirect URIs*: `http://localhost/authenticate`
+- *App homepage URL*: `http://localhost`

composer.json

@@ -13,6 +13,7 @@
         "inertiajs/inertia-laravel": "^2.0",
         "laravel/framework": "^12.0",
         "laravel/tinker": "^2.10.1",
+        "laravel/workos": "^0.2.1",
         "propaganistas/laravel-phone": "^6.0",
         "spatie/laravel-data": "^4.17",
         "spatie/laravel-medialibrary": "^11.13",

composer.lock

@@ -35,4 +35,11 @@
         ],
     ],
 
+    'workos' => [
+        'enabled' => env('WORKOS_ENABLED', false),
+        'api_key' => env('WORKOS_API_KEY'),
+        'client_id' => env('WORKOS_CLIENT_ID'),
+        'redirect_uri' => env('WORKOS_REDIRECT_URI', config('app.url') . '/authenticate'),
+    ],
+
 ];

config/services.php

@@ -19,4 +19,9 @@
 });
 
 require __DIR__.'/settings.php';
-require __DIR__.'/auth.php';
+
+if (config('services.workos.enabled')) {
+    require __DIR__.'/workos.php';
+} else {
+    require __DIR__.'/auth.php';
+}

routes/web.php

@@ -0,0 +1,18 @@
+<?php
+
+use Illuminate\Support\Facades\Route;
+use Laravel\WorkOS\Http\Requests\AuthKitAuthenticationRequest;
+use Laravel\WorkOS\Http\Requests\AuthKitLoginRequest;
+use Laravel\WorkOS\Http\Requests\AuthKitLogoutRequest;
+
+Route::get('login', function (AuthKitLoginRequest $request) {
+    return $request->redirect();
+})->middleware(['guest'])->name('login');
+
+Route::get('authenticate', function (AuthKitAuthenticationRequest $request) {
+    return tap(to_route('dashboard'), fn () => $request->authenticate());
+})->middleware(['guest']);
+
+Route::post('logout', function (AuthKitLogoutRequest $request) {
+    return $request->logout();
+})->middleware(['auth'])->name('logout');