GitHub - GetStream/stream-laravel: Laravel Client - Build Activity Feeds & Streams with GetStream.io (original) (raw)

Stream Laravel

stream-laravel is a Laravel client for Stream. You can use this in any Laravel application, or in any application that uses Eloquent ORM (illuminate/database) as a standalone ORM.

You can sign up for a Stream account at https://getstream.io/get_started.

Note there is also a lower level PHP - Stream integration library which is suitable for all PHP applications.

Build Activity Streams, News Feeds, and More

You can build:

• Activity Streams - like the one seen on GitHub
• A Twitter-like feed
• Instagram / Pinterest Photo Feeds
• Facebook-style newsfeeds
• A Notification System
• Lots more...

Demos

https://github.com/GetStream/Stream-Laravel-Example

https://github.com/GetStream/Stream-Example-PHP

Installation

Composer

Begin by installing this package through Composer. Edit your project's composer.json file to require get-stream/stream-laravel:

"require": {
    "get-stream/stream-laravel": "~2.3.5"
},

Next, update Composer:

Laravel

Laravel prior to 5.5 (no longer supported)

Add 'GetStream\StreamLaravel\StreamLaravelServiceProvider' to your list of providers in config/app.php:

'providers' => [
    GetStream\StreamLaravel\StreamLaravelServiceProvider::class,
    ...
],

And add the FeedManager facade 'GetStream\StreamLaravel\Facades\FeedManager' to your list of aliases in config/app.php:

'aliases' => [
    'FeedManager' => GetStream\StreamLaravel\Facades\FeedManager::class,
    ...
],

Publish the configuration file:

php artisan vendor:publish --provider="GetStream\StreamLaravel\StreamLaravelServiceProvider"

This will create config/stream-laravel.php. We will set our credentials after they are created in the Stream Dashboard.

GetStream.io Dashboard

Now, login to GetStream.io and create an application in the dashboard.

Retrieve the API key, API secret, and API app id, which are shown in your dashboard.

Create feeds in your new application. By default, you should create the following:

• user which is a flat feed.
• timeline which is a flat feed.
• timeline_aggregated which is an aggregated feed.
• notification which is a notification feed.

Stream-Laravel Config File

Set your key, secret, and app id in config/stream-laravel.php file as their are shown in your dashboard. Also set the location for good measure. For example:

return [

    /*
    |-----------------------------------------------------------------------------
    | Your GetStream.io API credentials (you can them from getstream.io/dashboard)
    |-----------------------------------------------------------------------------
    |
    */

    'api_key' => '[API KEY HERE]',
    'api_secret' => '[API SECRET HERE]',
    'api_app_id' => '[API APP ID HERE]',
    /*
    |-----------------------------------------------------------------------------
    | Client connection options
    |-----------------------------------------------------------------------------
    |
    */
    'location' => 'us-east',
    'timeout' => 3,
    /*
    |-----------------------------------------------------------------------------
    | The default feed manager class
    |-----------------------------------------------------------------------------
    |
    */

You can also set the name of your feeds here:

/*
    |-----------------------------------------------------------------------------
    | The feed that keeps content created by its author
    |-----------------------------------------------------------------------------
    |
    */
    'user_feed' => 'user',
    /*
    |-----------------------------------------------------------------------------
    | The feed containing notification activities
    |-----------------------------------------------------------------------------
    |
    */
    'notification_feed' => 'notification',
    /*
    |-----------------------------------------------------------------------------
    | The feeds that shows activities from followed user feeds
    |-----------------------------------------------------------------------------
    |
    */
    'news_feeds' => [
        'timeline' => 'timeline',
        'timeline_aggregated' => 'timeline_aggregated',
    ]

And that should get you off and running with Stream-Laravel. Have lots of fun!

Lumen Installation

Begin by installing this package through Composer.

composer require get-stream/stream-laravel

Add 'GetStream\StreamLaravel\StreamLumenServiceProvider' to the list of providers in bootstrap/app.php

$app->register(\GetStream\StreamLaravel\StreamLumenServiceProvider::class);

Manually create a config file in ./config/stream-laravel.php...