Socialstream is a third-party package for Laravel Jetstream. It replaces the published authentication and profile scaffolding provided by Laravel Jetstream, with scaffolding that has support for Laravel Socialite.

If you are unfamiliar with Laravel Socialite, it is strongly advised that you take a look at the official documentation.

Getting started with Socialstream is a breeze. With a simple two-step process to get you on your way to creating the next big thing. Inspired by the simplicity of Jetstream's installation process, Socialstream follows the same 'installation':

composer require joelbutcher/socialstream

php artisan socialstream:install

The socialstream:install command will overwrite the Jetstream published files which are required for Socialstream to work.

Note: If you don't have Laravel Jetstream installed, the above command will walk you through the steps required to install it.

Once Socialstream is installed, it will publish a config file. In this config file, you can define whether or not the packages alterations should be shown, the middleware used to wrap the routes as well as the providers that you wish to use:

<?php
return [
  'show' => true,
  'middleware => ['web'],
  'providers => [
    'github',
    'facebook',
    'google'
  ],
];

Once you’ve defined your providers, you will need to update your services.php config file and create client_id, client_secret and redirect keys for each provider:

'github' => [
  'client_id' => env('GITHUB_CLIENT_ID'),
  'client_secret' => env('GITHUB_CLIENT_SECRET'),
  'redirect' => env('GITHUB_REDIRECT'),
  // default is 'https://domain.com/oauth/github/callback'
],

To handle instances where Socialite throws an InvalidStateException a dedicated HandleInvalidState action is made available to you when you first install Socialstream. You are free to modify or extend this action according to your needs.

Alternatively, you may write your own action to handle the exception. To do so, you'll need to implement JoelButcher\Socialstream\Contracts\HandlesInvalidState and update the following line in App\Providers\SocialstreamServiceProvider

    Socialstream::handlesInvalidStateUsing(HandleInvalidState::class);

If you wish to use the community driven socialiteproviders package with Socialstream, you may do so by following their documentation on installing the package into a Laravel project. There are a few configuration steps you will need to go through first.

To implement a custom provider, you will need to create an SVG icon file (e.g. twitter-icon.blade.php or TwitterIcon.vue) to be used in the authentication cards and the account management panel.

You will then need to alter the appropriate published components with your new icons and provider condition:

• Connected Account component
• Socialstream Providers component

Note: Some providers will not return a token in the callback response. As such, you will need to modify the 2020_12_22_000000_create_connected_accounts_table.php migration to allow the token field to accept NULL values

Check out the CHANGELOG in this repository for all the recent changes.

Socialstream is developed and maintained by Joel Butcher

Socialstream has a strong community of contributors helping make it the best package for integrating Socialite into your application. You can view all contributers here

Socialstream is open-sourced software licensed under the MIT license.