tyler36/social-auth

This package is abandoned and no longer maintained. No replacement package was suggested.
There is no license information available for the latest version (0.3) of this package.

Social Authentication

0.3 2021-09-21 06:01 UTC

This package is auto-updated.

Last update: 2024-12-21 06:20:50 UTC


README

A simple package to add authentication via Socialite

User Flow

Route: login.sns - Validate provider - Send user to provider (expects callback)

Route: login.sns.callback - Validate provider - Create / Update User - Login if valid

Setup

  • Install package
composer require tyler36/social-auth
  • Publish assets
php artisan vendor:publish --provider=Tyler36\SocialAuth\SocialAuthServiceProvider
  • Run migration
php artisan migrate
  • Add social-auth routes to ./routes/web.php
require __DIR__.'/socialauth.php';
  • Adding providers. Create API key information for each provider you would like to you. Each provider requires a client_id, client_secret, & client_callback_url. A selection of some providers API website can be found in resources/lang/vendor/en/message.php file.

  • Update the services config file For security, it is recommended to add this to your ENV`` file, then add/update the section in you config/services.php``` file. EG.:

    'github' => [
        'client_id'     => env('GITHUB_CLIENT_ID'),
        'client_secret' => env('GITHUB_CLIENT_SECRET'),
        'redirect'      => env('GITHUB_CALLBACK_URL'),
    ],
  • Update the package config file You will also need to add an entry into the config/socialauth file before this package recognizes the provider as valid. EG.:
 'github' => true
  • Update factories. If you use model factories, you should update them

Testing

There are some (basic) tests.

phpunit .\vendor\tyler36\social-auth\tests