bonsaicms/serve-spa

Package for serving SPA (Single-Page-Application) from Laravel

1.0.1 2022-03-31 17:29 UTC

Requires

• php: ^7.3|^8.0
• laravel/framework: ^8.0|^9.0

MIT

• Matej Vitaz

• laravel
• SPA
• single-page-application
• Bonsai CMS

README

Introduction

The purpose of this package is to simply serve an Single-Page-Application from your Laravel backend. By 'serve' we mean to provide some content (HTML document) on the defined route as the HTTP response.

By default, this package will register route GET /spa (with name spa) and the route will serve a static SPA content from view named spa (resources/views/spa.blade.php or resources/views/spa.html etc.).

Installation

$ composer require bonsaicms/serve-spa

Configuration

You can publish the configuration file with the following command:

$ php artisan vendor:publish --tag=serve-spa

Then you can customize your config file app/config/serve-spa.php.

Default Configuration file

Notice, that you can define multiple SPAs in the serve configuration key.

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Array of Single Page Applications
    |--------------------------------------------------------------------------
    |
    | You can define multiple items here.
    |
    */

    'serve' => [

        /*
        |--------------------------------------------------------------------------
        | Example SPA
        |--------------------------------------------------------------------------
        */

        [

            /*
            |--------------------------------------------------------------------------
            | Name of the Route Serving the SPA
            |--------------------------------------------------------------------------
            */

            'routeName' => 'spa',

            /*
            |--------------------------------------------------------------------------
            | Route Configuration
            |--------------------------------------------------------------------------
            |
            | This configuration will be applied only for this SPA.
            |
            */

            'routeConfig' => [
                'prefix' => 'spa',
            ],

            /*
            |--------------------------------------------------------------------------
            | Response
            |--------------------------------------------------------------------------
            |
            | Example values:
            |
            |  - 'someViewName'
            |  - 'MyController@myMethod'
            |  - [ MyController::class, 'myMethod' ]
            |  - function () { return 'my custom response'; }
            |
            */

            'response' => 'spa',

        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Global Route Configuration
    |--------------------------------------------------------------------------
    |
    | This configuration will be applied for all defined SPAs.
    |
    */

    'globalRoutesConfig' => [
        'middleware' => 'web',
    ],
];