profile-filament-plugin

KO | EN

gitlite — search

#python #llm #ai #machine-learning #typescript #hacs #nextjs #developer-tools #agent #home-assistant #deep-learning #tensorflow

profile-filament-plugin

★ 39 Open GitHub ↗

Profile & MFA starter kit for filament.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Filament Profile

> **Warning:** While the plugin should be production ready, it is still in a pre-release stage. API and functionality are subject to change
> without a major version bump until a stable release is made.

[![Latest Version on Packagist](https://img.shields.io/packagist/v/rawilk/profile-filament-plugin.svg?style=flat-square)](https://packagist.org/packages/rawilk/profile-filament-plugin)
[![Tests](https://github.com/rawilk/profile-filament-plugin/actions/workflows/run-tests.yml/badge.svg)](https://github.com/rawilk/profile-filament-plugin/actions/workflows/run-tests.yml)
[![Total Downloads](https://img.shields.io/packagist/dt/rawilk/profile-filament-plugin.svg?style=flat-square)](https://packagist.org/packages/rawilk/profile-filament-plugin)
[![PHP from Packagist](https://img.shields.io/packagist/php-v/rawilk/profile-filament-plugin?style=flat-square)](https://packagist.org/packages/rawilk/profile-filament-plugin)
[![License](https://img.shields.io/github/license/rawilk/profile-filament-plugin?style=flat-square)](https://github.com/rawilk/profile-filament-plugin/blob/main/LICENSE.md)

![social image](https://github.com/rawilk/profile-filament-plugin/blob/main/assets/images/social-image.png?raw=true)

This package provides a [Filament](https://filamentphp.com/) plugin for a user profile. The plugin acts as a starting point for your user profile and provides
multi-factor authentication, password management, session management, and more. This plugin
takes care of a lot of the boilerplate code that is required for these functionalities.

Although this package is highly opinionated in how it handles many things, it is still flexible and customizable in most areas.

## Installation

You can install the package via composer:

```bash
composer require rawilk/profile-filament-plugin
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag="profile-filament-migrations"
php artisan migrate
```

You can publish the config file with:

```bash
php artisan vendor:publish --tag="profile-filament-config"
```

You can view the default configuration here: https://github.com/rawilk/profile-filament-plugin/blob/main/config/profile-filament.php

## Usage

In a panel service provider, register the plugin:

```php
use Rawilk\ProfileFilament\ProfileFilamentPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                ProfileFilamentPlugin::make()
            );
    }
}
```

Here is what the base profile page will look like without any configuration:

![base profile page](https://github.com/rawilk/profile-filament-plugin/blob/main/assets/images/pages/profile.png?raw=true)

## Documentation

For comprehensive documentation, please visit: https://randallwilk.dev/docs/profile-filament-plugin

## Scripts

### Setup

For convenience, you can run the setup bin script for easy installation for local development.

```bash
./bin/setup.sh
```

### Formatting

Although formatting is done automatically via workflow, you can format php code locally before committing with a composer script:

```bash
composer format
```

### Release

When a new release is ready, the `./bin/release.sh` script should be run. This script will compile the front-end assets provided by the package.

## Testing

```bash
composer test
```

## Changelog

Please see [CHANGELOG](https://github.com/rawilk/profile-filament-plugin/blob/main/CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](https://github.com/rawilk/profile-filament-plugin/blob/main/.github/CONTRIBUTING.md) for details.

## Security

Please review [my security policy](https://github.com/rawilk/profile-filament-plugin/blob/main/.github/SECURITY.md) on how to report security vulnerabilities.

## Credits

- [Randall Wilk](https://github.com/rawilk)
- [All Contributors](https://github.com/rawilk/profile-filament-plugin/graphs/contributors)
- [Filament](https://filamentphp.com) - For inspiration on multi-factor authentication concepts
- [spatie/laravel-passkeys](https://github.com/spatie/laravel-passkeys) - For inspiration on some webauthn/passkey concepts
- [claudiodekker/laravel-auth](https://github.com/claudiodekker/laravel-auth) - For some inspirations on multi-factor and sudo mode concepts
- [protonemedia/laravel-verify-new-email](https://github.com/protonemedia/laravel-verify-new-email) - For inspirations on pending email change functionalities

`Agent` service class for browser/device detection is derived from:

- [Jenssegers/Agent](https://github.com/jenssegers/agent)
- [Laravel Jetstream](https://github.com/laravel/jetstream)

## Alternatives

- [Filament Breezy](https://github.com/jeffgreco13/filament-breezy)

## License

The MIT License (MIT). Please see [License File](https://github.com/rawilk/profile-filament-plugin/blob/main/LICENSE.md) for more information.

profile-filament-plugin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README