README

Currently WIP

Created by: SteelAnts s.r.o.

Install

1. Artisan Command

install:auth

1. add routes to web.php

Route::auth();

Optional Features

*Both features are disabled by default to avoid route collisions.

Email verification

• Protects routes with the verified middleware and provides notice/verify/resend endpoints when enabled.
• Requires Route::auth(['verify' => true]); and the HandlesEmailVerification plugin trait added to your AuthController next to Authentication.

MFA (TOTP)

• Adds TOTP setup/verification screens and enforces checks via the verified.totp middleware.
• Requires Route::auth(['totp' => true]); and the HandlesTotp plugin trait added to your AuthController next to Authentication.
• Install QR dependency in your app: composer require endroid/qr-code.

Auth controller setup

Your AuthController pulls in the core auth trait, plus the plugin traits for optional features:

use SteelAnts\LaravelAuth\Traits\Authentication;
use SteelAnts\LaravelAuth\Traits\HandlesEmailVerification;
use SteelAnts\LaravelAuth\Traits\HandlesTotp;

class AuthController extends Controller
{
    use Authentication;
    use HandlesEmailVerification; // enable email verification flows
    use HandlesTotp;              // enable TOTP MFA flows
}

Development

1. Create subfolder /packages at root of your laravel project

2. clone repository to sub folder /packages (you need to be positioned at root of your laravel project in your terminal)

git clone https://github.com/steelants/laravel-auth.git ./packages/laravel-auth

1. edit composer.json file

"autoload": {
	"psr-4": {
		"SteelAnts\\LaravelAuth\\": "packages/laravel-auth/src/"
	}
}

1. Add provider to bootstrap/providers.php

return [
	...
	SteelAnts\LaravelAuth\AuthServiceProvider::class,
	...
];

1. aplicate packages changes

php artisan install:auth --force

Contributors

Other Packages

steelants/datatable

steelants/form

steelants/modal

steelants/boilerplate