Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
inmanturbo committed Feb 24, 2024
1 parent 1dd620c commit b8543b8
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 178 deletions.
177 changes: 1 addition & 176 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ composer require laravel/jetstream
```

```bash
php artisan jetstream:install livewire --api
php artisan jetstream:install livewire --api --dark --pest
```

See [Docs](https://jetstream.laravel.com/installation.html) for more info.
Expand All @@ -33,185 +33,10 @@ See [Docs](https://jetstream.laravel.com/installation.html) for more info.
composer require headerx/laravel-jetstream-passport
```

```bash
php artisan migrate
```

```bash
php artisan jetstream-passport:install
```

3. in your user model replace the `Laravel\Sanctum\HasApiTokens` trait with `Laravel\Passport\HasApiTokens`:

```diff
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Fortify\TwoFactorAuthenticatable;
use Laravel\Jetstream\HasProfilePhoto;
- use Laravel\Sanctum\HasApiTokens;
+ use Laravel\Passport\HasApiTokens;

class User extends Authenticatable
{
use HasApiTokens;
...
}

```

4. in config/auth.php set the `api.driver` to `passport`:

```php
...
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],

'api' => [
'driver' => 'passport',
'provider' => 'users',
'hash' => false,
],
],
...
```

5. replace the contents of resources/views/vendor/passport/authorize.blade.php with the following:

```blade
@include('jetstream-passport::authorize')
```

6. replace the contents of resources/views/api/index.blade.php with the following:

```blade
@include('jetstream-passport::index')
```

You can publish the views with:

```bash
php artisan vendor:publish --provider="HeaderX\JetstreamPassport\JetstreamPassportServiceProvider" --tag="jetstream-passport-views"
```

7. finally, in one of you application's service providers, add passport routes and define scopes for your passport tokens, and set up jetstream to use them, example:

```php
<?php
// app/Providers/JetstreamServiceProvider
namespace App\Providers;

// ...
use Illuminate\Support\ServiceProvider;
use Laravel\Jetstream\Jetstream;
use Laravel\Passport\Passport;

class JetstreamServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*/
public function register(): void
{
//
}

/**
* Bootstrap any application services.
*/
public function boot(): void
{
$this->configurePermissions();

// ...
}

/**
* Configure the roles and permissions that are available within the application.
*/
protected function configurePermissions(): void
{

// define scopes for passport tokens
Passport::tokensCan([
'create' => 'Create resources',
'read' => 'Read Resources',
'update' => 'Update Resources',
'delete' => 'Delete Resources',
]);

// default scope for passport tokens
Passport::setDefaultScope([
// 'create',
'read',
// 'update',
// 'delete',
]);

// same as passport default above
Jetstream::defaultApiTokenPermissions(['read']);

// use passport scopes for jetstream token permissions
Jetstream::permissions(Passport::scopeIds());
}
}
```

8. Now you can also edit `routes/api.php`

```diff
<?php

use Illuminate\Auth\Middleware\Authenticate;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/user', function (Request $request) {
return $request->user();
-})->middleware(Authenticate::using('sanctum'));
+})->middleware('auth:api');
```

9. Lastly, for postcss processing of styles, you can edit tailwind.config.js to include '.vendor/headerx/laravel-jetstream-passport/resources/views/**/*.blade.php'

```js
import defaultTheme from 'tailwindcss/defaultTheme';
import forms from '@tailwindcss/forms';
import typography from '@tailwindcss/typography';

/** @type {import('tailwindcss').Config} */
export default {
content: [
'./vendor/laravel/framework/src/Illuminate/Pagination/resources/views/*.blade.php',
'./vendor/headerx/laravel-jetstream-passport/resources/views/**/*.blade.php',
'./vendor/laravel/jetstream/**/*.blade.php',
'./storage/framework/views/*.php',
'./resources/views/**/*.blade.php',
],

theme: {
extend: {
fontFamily: {
sans: ['Figtree', ...defaultTheme.fontFamily.sans],
},
},
},

plugins: [forms, typography],
};
```

## Testing

```bash
Expand Down
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
}
],
"require": {
"php": "^8.1",
"php": "^8.2",
"laravel/framework": "^11.0",
"laravel/passport": "*",
"livewire/livewire": "^3.4",
"spatie/laravel-package-tools": "^1.16.2"
Expand Down
2 changes: 1 addition & 1 deletion stubs/config/auth.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
'driver' => 'session',
'provider' => 'users',
],

'api' => [
'driver' => 'passport',
'provider' => 'users',
Expand Down
8 changes: 8 additions & 0 deletions stubs/routes/api.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/user', function (Request $request) {
return $request->user();
})->middleware('auth:api');

0 comments on commit b8543b8

Please sign in to comment.