Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/afsakar/filament-otp-login
OTP Login for FilamentPHP
https://github.com/afsakar/filament-otp-login
filament filament-package filament-plugin filamentphp laravel livewire otp-verification
Last synced: 3 days ago
JSON representation
OTP Login for FilamentPHP
- Host: GitHub
- URL: https://github.com/afsakar/filament-otp-login
- Owner: afsakar
- License: mit
- Created: 2024-03-24T12:41:29.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-04-29T05:33:22.000Z (5 months ago)
- Last Synced: 2024-05-21T02:23:46.601Z (5 months ago)
- Topics: filament, filament-package, filament-plugin, filamentphp, laravel, livewire, otp-verification
- Language: PHP
- Homepage: https://filamentphp.com/plugins/afsakar-otp-login
- Size: 49.8 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
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
# OTP Login for FilamentPHP
[](https://packagist.org/packages/afsakar/filament-otp-login)
[](https://packagist.org/packages/afsakar/filament-otp-login)
This package is an OTP Login for FilamentPHP. It is a simple package that allows you to login to your FilamentPHP application using OTP.
## Installation
You can install the package via composer:
```bash
composer require afsakar/filament-otp-login
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag="filament-otp-login-migrations"
php artisan migrate
```
You can publish the config and translations files with:
```bash
php artisan vendor:publish --tag="filament-otp-login-config"
php artisan vendor:publish --tag="filament-otp-login-translations"
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="filament-otp-login-views"
```
This is the contents of the published config file:
```php
return [
'table_name' => 'otp_codes', // Table name to store OTP codes
'otp_code' => [
'length' => env('OTP_LOGIN_CODE_LENGTH', 6), // Length of the OTP code
'expires' => env('OTP_LOGIN_CODE_EXPIRES_SECONDS', 120), // Expiration time of the OTP code in seconds
],
];
```
## Usage
Just register the `Afsakar\FilamentOtpLogin\FilamentOtpLoginPlugin` plugin in the your panel provider file.
```php
use Afsakar\FilamentOtpLogin\FilamentOtpLoginPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
FilamentOtpLoginPlugin::make(),
]);
}
```
If you want to ignore specific user groups from OTP login just implement the `Afsakar\FilamentOtpLogin\Models\Contracts\CanLoginDirectly` trait in your User model.
```php
use Afsakar\FilamentOtpLogin\Models\Contracts\CanLoginDirectly;
class User extends Authenticatable implements CanLoginDirectly
{
use HasFactory, Notifiable;
// other user model code
public function canLoginDirectly(): bool
{
return str($this->email)->endsWith('@example.com');
}
}
```
_*Note:* For medium and large scale applications, you only need to run "php artisan model:prune" command as cron to prevent the otp_code table from bloating and performance issues._
## Custom Login Page
If you want to customize the login page, you can extend the `\Afsakar\FilamentOtpLogin\Filament\Pages\Login` page and set your custom login page to plugin in the panel provider file with `loginPage` method.
```php
plugins([
FilamentOtpLoginPlugin::make()
->loginPage(OverrideLogin::class),
]);
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Azad Furkan ŞAKAR](https://github.com/afsakar)
- [All Contributors](../../contributors)
- [OTP Input inspiration](https://github.com/rajeshdewle/otp-pin-using-alpine-js-and-tailwindcss)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.