Image you are working on new app. Your client wants to see that progress that you've made. However your site isn't ready for prime time yet. You could already create some login functionality and only display the site to logged in users. But why bother creating users when there is a more pragmatic approach?

This package provides a route middleware to protected routes from prying eyes. All users that visit a protocted route will be redirect to a configurable url (e.g. /work-in-progress). To view the content of the routes a visitor must first visit a url that grants access (e.g. /demo).

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

You can install the package via composer:

$ composer require spatie/laravel-demo-mode

Next up, the service provider must be registered:

'providers' => [
    ...
    Spatie\DemoMode\DemoServiceProvider::class,

];

The \Spatie\DemoMode\DemoMode::class-middleware must be registered in the kernel:

//app/Http/Kernel.php

protected $routeMiddleware = [
  ...
  'DemoMode' => \Spatie\DemoMode\DemoMode::class,
];

Naming the route middleware DemoMode is just a suggestion. You can give it any name you'd like.

You must publish the config file:

php artisan vendor:publish --provider="Spatie\DemoMode\DemoModeServiceProvider"

This is the content of the published file laravel-demo-mode.php:

return [
    
    /**
     * This is the master switch to enable demo mode.
     */
    'enabled' => env('DEMO_MODE_ENABLED', true),
    
    /**
     * Visitors that go an url that is protected by demo mode will be redirected.
     * to this url
     */
    'redirect_unauthorized_users_to_url' => '/work-in-progress',

    /**
     * Visiting this url will grant access to the pages protected by demo mode.
     */
    'grant_access_to_demo_url' => '/demo',

    /**
     * After have been granted access visitors will be redirected to this url.
     */
    'redirect_authorized_users_to_url' => '/',

];

You can protect some routes by using the demoMode-middleware on them.

//only users with the viewTopSecretPage-ability be able to see this

Route::group(['middleware' => 'demoMode'], function () {
    Route::get('/secret-route', 'SecretController@index');

    Route::get('/another-secret-route', 'AnotherSecretController@index';
});

Unless you visit the url specified in the grant_access_to_demo_url-key of the config file first, visiting these routes will result in a redirect in to the url specified in the redirect_unauthorized_users_to_url-key of the config file.

Please see CHANGELOG for more information what has changed recently.

$ composer test

Please see CONTRIBUTING for details.

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

• Freek Van der Herten
• All Contributors

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

The MIT License (MIT). Please see License File for more information.