Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rawilk/profile-filament-plugin
Profile & MFA starter kit for filament.
https://github.com/rawilk/profile-filament-plugin
filamentphp laravel mfa totp user-profile webauthn
Last synced: 12 days ago
JSON representation
Profile & MFA starter kit for filament.
- Host: GitHub
- URL: https://github.com/rawilk/profile-filament-plugin
- Owner: rawilk
- License: mit
- Created: 2023-08-19T15:43:39.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-28T17:25:29.000Z (15 days ago)
- Last Synced: 2024-10-28T18:47:42.783Z (15 days ago)
- Topics: filamentphp, laravel, mfa, totp, user-profile, webauthn
- Language: PHP
- Homepage: https://randallwilk.dev/docs/profile-filament-plugin
- Size: 2.88 MB
- Stars: 26
- Watchers: 3
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 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.
[](https://packagist.org/packages/rawilk/profile-filament-plugin)
[](https://github.com/rawilk/profile-filament-plugin/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/rawilk/profile-filament-plugin)
[](https://packagist.org/packages/rawilk/profile-filament-plugin)
[](https://github.com/rawilk/profile-filament-plugin/blob/main/LICENSE.md)
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. A lot of the boilerplate code that is required for these functionalities
is taken care of by this plugin.
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:
## 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)
- [livewire/livewire](https://livewire.laravel.com) - For some JS code snippets
- [laragear/webauthn](https://github.com/Laragear/WebAuthn) - For inspiration on some webauthn 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.