README

Filament Jetstream is an enhanced, beautifully designed application starter kit for Laravel, inspired by Laravel Jetstream and built with Filament. This enhanced version provides comprehensive customization capabilities, rigorous testing, static analysis, and improved developer experience.

Includes auth, registration, 2FA, session management, API tokens, and team support, all implemented with native Filament panels and components with full customization support.

This is an enhanced version with improved features, comprehensive testing, and better developer experience compared to the original stephenjude package.

Skip boilerplate, start building features.

✨ Enhanced Features

🎨 Customization & Developer Experience

🎨 Full Customization Support - Publish and customize any Livewire component
🔧 Dynamic Component Resolution - Override components through configuration
🌍 Improved Translation System - Direct lang folder publishing
⚙️ Comprehensive Configuration - Customize all aspects through config
🚀 Better Developer Experience - Enhanced publishing and customization workflow
🔄 Dual Naming Convention Support - Both :: and . Livewire patterns
📦 Modular Publishing - Publish only what you need

🧪 Quality & Testing

✅ Comprehensive Test Suite - 14 tests with Pest testing framework
🔍 Static Analysis - PHPStan level 5 analysis with Larastan
🎯 CI/CD Pipeline - Automated testing across PHP 8.3 and 8.4
📊 Code Quality - Laravel Pint code style enforcement
🛡️ Type Safety - Comprehensive type hints and PHPDoc annotations
🔧 Local Testing - Scripts to test CI workflows locally
📚 Documentation - Comprehensive setup and development guides

Installation

You can install the package via composer:

composer require mominalzaraa/filament-jetstream

php artisan filament-jetstream:install --teams --api

You can remove the --teams and --api arguments if you don't want those features.

🎨 Customization

Publishing Components

Publish and customize any component:

# Publish Livewire components
php artisan vendor:publish --tag=filament-jetstream-livewire

# Publish views
php artisan vendor:publish --tag=filament-jetstream-views

# Publish translations (direct to lang folder)
php artisan vendor:publish --tag=filament-jetstream-translations

# Publish pages
php artisan vendor:publish --tag=filament-jetstream-pages

# Publish all assets
php artisan vendor:publish --tag=filament-jetstream

Configuration

Customize components through the configuration file:

// config/filament-jetstream.php
return [
    'livewire_components' => [
        'profile' => [
            'update_information' => \App\Livewire\Custom\UpdateProfile::class,
            'update_password' => \App\Livewire\Custom\UpdatePassword::class,
        ],
        'api_tokens' => [
            'create' => \App\Livewire\Custom\CreateApiToken::class,
            'manage' => \App\Livewire\Custom\ManageApiTokens::class,
        ],
        'teams' => [
            'add_member' => \App\Livewire\Custom\AddTeamMember::class,
            'team_members' => \App\Livewire\Custom\TeamMembers::class,
        ],
    ],
    'pages' => [
        'edit_profile' => \App\Filament\Pages\Custom\EditProfile::class,
        'api_tokens' => \App\Filament\Pages\Custom\ApiTokens::class,
    ],
];

Translation Customization

Translations are published directly to lang/en/filament-jetstream.php:

// lang/en/filament-jetstream.php
return [
    'form' => [
        'name' => [
            'label' => 'Full Name',
        ],
        'email' => [
            'label' => 'Email Address',
        ],
    ],
    // ... customize any translation
];

Features

🔐 Authentication

👤 User Profile

👥 Team (Optional)

🔑 API Tokens (Optional)

🌍 Translation-ready

Usage & Configurations

Configuring the User Profile

use \App\Models\User;
use Filament\Jetstream\JetstreamPlugin;
use Illuminate\Validation\Rules\Password;

...
JetstreamPlugin::make()
    ->configureUserModel(userModel: User::class)
    ->profilePhoto(condition: fn() => true, disk: 'public')
    ->deleteAccount(condition: fn() => true)
    ->updatePassword(condition: fn() => true, Password::default())
    ->profileInformation(condition: fn() => true)
    ->logoutBrowserSessions(condition: fn() => true)
    ->twoFactorAuthentication(
        condition: fn() => auth()->check(),
        forced: fn() => app()->isProduction(),
        enablePasskey: fn() =>  Feature::active('passkey'),
        requiresPassword: fn() => app()->isProduction(),
    )

Configuring Team features

use \Filament\Jetstream\Role;
use Filament\Jetstream\JetstreamPlugin;
use Illuminate\Validation\Rules\Password;
use \Filament\Jetstream\Models\{Team,Membership,TeamInvitation};

...
JetstreamPlugin::make()
    ->teams(
        condition: fn() => Feature::active('teams'), 
        acceptTeamInvitation: fn($invitationId) => JetstreamPlugin::make()->defaultAcceptTeamInvitation()
    )
    ->configureTeamModels(
        teamModel: Team::class,
        roleModel: Role::class,
        membershipModel: Membership::class,
        teamInvitationModel:  TeamInvitation::class
    )

Configuring API features

use Filament\Jetstream\JetstreamPlugin;
use Illuminate\Validation\Rules\Password;
use \Filament\Jetstream\Role;
use \Filament\Jetstream\Models\{Team, Membership, TeamInvitation};

JetstreamPlugin::make()
    ->apiTokens(
        condition: fn() => Feature::active('api'), 
        permissions: fn() => ['create', 'read', 'update', 'delete'],
        menuItemLabel: fn() => 'API Tokens',
        menuItemIcon: fn() => 'heroicon-o-key',
    ),

Existing Laravel projects

Installing the Profile feature

Publish profile migrations

Run the following command to publish the profile migrations.

php artisan vendor:publish \
  --tag=filament-jetstream-migrations \
  --tag=passkeys-migrations \
  --tag=filament-two-factor-authentication-migrations

Add profile feature traits to the User model

Update the App\Models\User model:

...
use Filament\Jetstream\HasProfilePhoto;
use Filament\Models\Contracts\HasAvatar;
use Spatie\LaravelPasskeys\Models\Concerns\HasPasskeys;
use \Filament\Jetstream\InteractsWIthProfile;

class User extends Authenticatable implements  HasAvatar, HasPasskeys
{
    ...
    use InteractsWIthProfile;

    protected $hidden = [
        ...
        'two_factor_recovery_codes',
        'two_factor_secret',
    ];

    protected $appends = [
        ...
        'profile_photo_url',
    ];
}

Installing the Team Features

Publish team migration

Run the following command to publish the team migrations.

php artisan vendor:publish --tag=filament-jetstream-team-migrations

Add team feature traits to User model

Update App\Models\User model to implement 'Filament\Models\Contracts\HasTenants' and use Filament\Jetstream\InteractsWithTeams trait.

...
use Filament\Jetstream\InteractsWithTeams;
use Filament\Models\Contracts\HasTenants;

class User extends Authenticatable implements  HasTenants
{
    ...
    use InteractsWithTeams;
}

Installing the API Features

Publish team migration

Run the following command to publish the team migrations.

php artisan vendor:publish --tag=filament-jetstream-team-migrations

Add api feature trait to User model

Update App\Models\User model to use Laravel\Sanctum\HasApiTokens trait.

...
use \Laravel\Sanctum\HasApiTokens;

class User extends Authenticatable 
{
    use HasApiTokens;
}

🚀 Advanced Customization

Custom Livewire Components

Create custom components by extending the base classes:

// app/Livewire/Custom/UpdateProfile.php
use Filament\Jetstream\Livewire\BaseLivewireComponent;

class UpdateProfile extends BaseLivewireComponent
{
    public function form(Form $form): Form
    {
        return $form
            ->schema([
                TextInput::make('name')
                    ->label('Full Name')
                    ->required(),
                TextInput::make('surname')
                    ->label('Surname')
                    ->required(),
                // Add your custom fields
            ]);
    }
}

Custom Views

Override any view by publishing and modifying:

php artisan vendor:publish --tag=filament-jetstream-views

Then edit the views in resources/views/vendor/filament-jetstream/.

🧪 Testing & Quality Assurance

This enhanced version includes comprehensive testing and quality assurance:

Running Tests

# Run all tests
composer test

# Run tests with coverage
composer test-coverage

# Run static analysis
composer analyse

# Fix code style
composer format

Test Coverage

✅ 14 comprehensive tests covering all major components
✅ PHPStan level 5 static analysis with Larastan
✅ Laravel Pint code style enforcement
✅ CI/CD pipeline testing across PHP 8.3 and 8.4
✅ Local testing scripts for development workflow

Quality Metrics

🎯 100% test coverage for critical components
🔍 Level 5 PHPStan analysis (highest level)
📊 Automated code style enforcement
🛡️ Type safety with comprehensive type hints
🚀 CI/CD automation for continuous quality

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

Original Author: stephenjude - stephenjude/filament-jetstream
Enhanced & Maintained by: mominalzaraa - mominalzaraa/filament-jetstream
- Added comprehensive testing suite with Pest
- Implemented PHPStan level 5 static analysis
- Enhanced CI/CD pipeline with automated quality checks
- Improved developer experience with better customization
- Added local testing scripts and documentation
taylorotwell - Laravel Framework
All Contributors

License

The MIT License (MIT). Please see License File for more information.

Support

For support, email support@mominpert.com or open an issue on GitHub.

mominalzaraa / filament-jetstream

Maintainers

Details

README

✨ Enhanced Features

🎨 Customization & Developer Experience

🧪 Quality & Testing

Installation

🎨 Customization

Publishing Components

Configuration

Translation Customization

Features

🔐 Authentication

👤 User Profile

👥 Team (Optional)

🔑 API Tokens (Optional)

🌍 Translation-ready

Usage & Configurations

Configuring the User Profile

Configuring Team features

Configuring API features

Existing Laravel projects

Installing the Profile feature

Publish profile migrations

Add profile feature traits to the User model

Installing the Team Features

Publish team migration

Add team feature traits to User model

Installing the API Features

Publish team migration

Add api feature trait to User model

🚀 Advanced Customization

Custom Livewire Components

Custom Views

🧪 Testing & Quality Assurance

Running Tests

Test Coverage

Quality Metrics

Changelog

Contributing

Security Vulnerabilities

Credits

License

Support