README

This is a demo package that extracts the authentication controllers from a Laravel application.

Note: This code heavily borrows from Laravel Breeze, a Laravel starter kit for authentication scaffolding.

Installation

Add the package to your composer.json file:

"require": {
    "ryanhellyer/login-package-demo": "@dev"
},
"repositories": [
    {
        "type": "path",
        "url": "../login_package_demo"
    }
]

Run composer update.

Add the service provider to your config/app.php file:

'providers' => [
    // ...
    RyanHellyer\LoginPackageDemo\LoginPackageDemoServiceProvider::class,
],

Run the interactive setup command (recommended):
```
php artisan login-package-demo:install
```
This will:
- Prompt you for your User model class
- Optionally customize route paths
- Automatically add .env variables
- Publish and configure the config file
Or manually configure:
```
php artisan vendor:publish --provider="RyanHellyer\LoginPackageDemo\LoginPackageDemoServiceProvider"
```
Then update your config/login-package-demo-auth.php file and .env file manually.

Usage

This package provides the following routes:

login
logout
register
forgot-password
reset-password
verify-email
confirm-password
password

Using Built-in Views

You can include the package's built-in form views anywhere in your application:

{{-- Include login form --}}
@include('login-package-demo::auth.login')

{{-- Include registration form --}}
@include('login-package-demo::auth.register')

{{-- Include forgot password form --}}
@include('login-package-demo::auth.forgot-password')

{{-- Include confirm password form --}}
@include('login-package-demo::auth.confirm-password')

The GET routes redirect to / by default, so users should embed forms using the @include() directive rather than visiting dedicated pages.

Customizing Routes

All route paths can be customized to match your application's URL structure. You can override routes in two ways:

Method 1: Environment Variables

Add the following to your .env file:

LOGIN_PACKAGE_LOGIN_PATH=sign-in
LOGIN_PACKAGE_REGISTER_PATH=sign-up
LOGIN_PACKAGE_LOGOUT_PATH=sign-out
LOGIN_PACKAGE_FORGOT_PASSWORD_PATH=forgot-password
LOGIN_PACKAGE_RESET_PASSWORD_PATH=reset-password
LOGIN_PACKAGE_VERIFY_EMAIL_PATH=verify-email
LOGIN_PACKAGE_CONFIRM_PASSWORD_PATH=confirm-password
LOGIN_PACKAGE_PASSWORD_PATH=password

Method 2: Config File

After publishing the config file, edit config/login-package-demo-auth.php:

'routes' => [
    'login' => 'sign-in',
    'register' => 'sign-up',
    'logout' => 'sign-out',
    // ... etc
],

Important Notes

Route names remain consistent regardless of path customization. For example, route('login') will always work, even if you change the path to sign-in.
If you customize reset-password or verify-email paths, the route parameters ({token}, {id}/{hash}) will be automatically appended to your custom path.
Default paths are used if no customization is provided, so the package works out of the box.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ryanhellyer / login-package-demo

Maintainers

Details