Installation

Learn how to get Laravel Streams up and running.

Server Requirements

To run Laravel Streams you will need to meet Laravel server requirements.

Supported Image Libraries

Please ensure one of the following libraries is installed in order to support image manipulation.

  • GD Library
  • Imagick PHP extension

Downloading Streams

Via Composer Create-Project

When creating a new Streams project, the core, ui, and api packages are all included by default.

composer create-project streams/streams example.local --stability=dev

There is no installer as there is no traditional database requirement.

Local Development Server

If you have PHP installed locally and you would like to use PHP's built-in development server to serve your application, you may use the serve Artisan command to start a development server:

php artisan serve

What's next?

Your streams project is now ready for you to start coding.

Ready to dive in?

Existing Laravel Projects

You can add the Streams platform to existing Laravel projects by requiring the packages you need.

Requiring Packages

The core package is responsible for the meat and taters; it is the only required package.

composer require streams/core

To include UI features:

composer require streams/ui

To include API features:

composer require streams/api

Update Composer Scripts

This step is optional. You may find it helpful to compare our default scripts below to your own and decide what you would like to include.

// composer.json
"scripts": {
    "pre-autoload-dump": [
        "rm -Rf bootstrap/cache/*.php"
    ],
    "post-autoload-dump": [
        "Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
        "@php artisan package:discover --ansi",
        "@php artisan clear --ansi",
        "@php artisan vendor:publish --ansi --tag=public",
        "@php artisan queue:restart --ansi"
    ],
    "post-root-package-install": [
        "@php -r \"file_exists('.env') || copy('.env.example', '.env');\""
    ],
    "post-create-project-cmd": [
        "@php artisan key:generate --ansi"
    ]
}

Updating

From within your project, use Composer to update individual packages:

composer update streams/core --with-dependencies
composer update streams/api --with-dependencies
composer update streams/ui --with-dependencies

You can, of course, update your entire project using composer update.