Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.75 KB

README.md

File metadata and controls

65 lines (41 loc) · 2.75 KB
Raw

Add required configs for Fortify and Sanctum based SPA auth

Total Downloads

Because Fortify is designed to be frontend agnostic, it requires some configuration if you'd like to use it with an SPA on a subdomain and Sanctum. This package provides the required configurations for that.

What this package does

  • Adds CORS paths for Sanctum cookie and Fortify routes, including login, logout, and more
  • Forces CORS with_credentials to true
  • Adds API route to get currently authenticated user (both for cookie based auth and API token based auth), /api/user
  • Adds optional route to check if email exists (like Google login where it asks you for your email, and depending on if it exists or not, it will either ask you for password or create a new account)
  • Forces Fortify config option "views" to true, where each view redirects to the SPA as defined in the config (see below)
  • Adds loginView, registerView, twoFactorChallengeView, requestPasswordResetLinkView, resetPasswordView, verifyEmailView, and confirmPasswordView definitions for Fortify that redirect to your SPA app, with fully configurable paths (useful for links sent in emails, for example)
  • Forces the Fortify home config option to keep the path defined but prepend it with your SPA URL, or, if its already a URL, keep it as such
  • Allows setting the app language via Accept-Language header
  • Redirects any non-API route 404s to your SPA app (which also means that if you don't have a home route, it will redirect to your SPA app home)

Installation

You can install the package via composer:

composer require mmedia/laravel-spa

Usage

The service provider will automatically add the functionality as described above. You can publish the config file with:

php artisan vendor:publish --provider="Mmedia\LaravelSpa\LaravelSpaServiceProvider" --tag="config"

The package will automatically add the SetLocale global middleware, so you can change your app locale with the Accept-Language header.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.