README

Auto-resetting demo environment for Laravel applications with Filament integration. Perfect for showcasing your Laravel projects with automatic database resets every 30 minutes.

Looking for the LaraCoreKit starter bundle?

For your application, install the public frontend and administration core from Packagist:

composer create-project laravel/laravel my-app "~13.0"
cd my-app
composer require programmernomad/laracorekit:"~0.2.0"
php artisan laracorekit:install

These commands create Laravel and install the core, editable starter homepage and component library. They do not enable sample accounts or automatic database resets. Before serving the application, follow the core installation guide for database setup and administrator creation. This demo module is a separate optional package; it is not required by the core.

Disposable demos only: enabling this module can schedule database resets, erase data and expose sample credentials. Use a separate database/storage and least-privilege credentials. Domain checks do not replace infrastructure isolation. Never enable it in a customer application.

Features

Auto-Reset Database: Automatically fresh migrate + seed every 30 minutes (configurable)
Demo Credentials Banner: Show login credentials on auth pages and admin dashboard
Filament Integration: Beautiful admin widgets displaying demo info
Action Blocking: Prevent destructive operations (user deletion, critical settings)
Media Cleanup: Auto-delete uploaded files on reset
Session & Cache Clear: Clean state on every reset
Security: Domain whitelisting, production safeguards
Cron Scheduling: Integrated with Laravel scheduler
Customizable: Full control over reset interval, credentials, blocked actions

Use Cases

Demonstration websites on disposable infrastructure.
Isolated testing sandboxes.
Training environments with resettable sample data.

Requirements

PHP 8.2 or higher
Laravel 11.0, 12.0, or 13.0 (Laravel 13 requires PHP 8.3+)
Filament 3.0, 4.0, or 5.0 (optional, for admin widgets)

Installation

Install via Composer:

composer require programmernomad/laracorekit-demo-module

The package will automatically register via Laravel's package auto-discovery.

Configuration

Step 1: Publish Configuration

php artisan vendor:publish --tag=demo-config

This creates config/demo.php with all available options.

Step 2: Update `.env`

Add these variables to your .env file:

# Demo Mode Configuration
DEMO_MODE=true
DEMO_RESET_INTERVAL=30

# Demo Credentials (shown on login pages)
DEMO_ADMIN_EMAIL=admin@laracorekit.com
DEMO_ADMIN_PASSWORD=Admin@123
DEMO_USER_EMAIL=user@laracorekit.com
DEMO_USER_PASSWORD=User@123

Step 3: Setup Cron Job

The module uses Laravel's task scheduler. Add this to your server's crontab:

* * * * * cd /path/to/your/project && php artisan schedule:run >> /dev/null 2>&1

For Plesk Control Panel:

Go to Scheduled Tasks (Cron Jobs)
Add new task with command:

cd /var/www/vhosts/yourdomain.com && php artisan schedule:run >> /dev/null 2>&1

Run: Every minute

Usage

Enable Demo Mode

Simply set in your .env:

DEMO_MODE=true

The module will:

Show demo credentials on login pages
Display admin dashboard banner with credentials
Block destructive actions
Auto-reset database every 30 minutes

Manual Database Reset

Force an immediate reset:

php artisan demo:reset

With confirmation prompt:

php artisan demo:reset --force

Disable Demo Mode

Set in .env:

DEMO_MODE=false

All demo features are disabled. No overhead.

Customization

Change Reset Interval

In config/demo.php or .env:

# Reset every 60 minutes instead of 30
DEMO_RESET_INTERVAL=60

Add Custom Blocked Actions

In config/demo.php:

'blocked_actions' => [
    'user.delete',
    'user.force-delete',
    'role.delete',
    'backup.run',
    'your-custom-action', // Add your own
],

Customize Banner Appearance

In config/demo.php:

'banner' => [
    'show_on_login' => true,
    'show_on_admin' => true,
    'background_color' => 'yellow-50',
    'border_color' => 'yellow-500',
    'text_color' => 'yellow-900',
],

Domain Whitelisting (Security)

Only allow demo mode on specific domains:

'allowed_hosts' => [
    'demo.yourdomain.com',
    'localhost',
    '127.0.0.1',
],

Integration with Filament

Display Demo Banner in Admin Dashboard

The module automatically registers a Filament widget. To display it:

Option 1: In Dashboard Page

use LaraCoreKit\DemoModule\Filament\Widgets\DemoBannerWidget;

class Dashboard extends Page
{
    protected function getHeaderWidgets(): array
    {
        return [
            DemoBannerWidget::class,
        ];
    }
}

Option 2: In Custom Filament Page

use LaraCoreKit\DemoModule\Filament\Widgets\DemoBannerWidget;

protected function getHeaderWidgets(): array
{
    return [
        DemoBannerWidget::class,
    ];
}

The widget will only show when DEMO_MODE=true.

UI Integration

See UI_INTEGRATION_GUIDE.md for complete integration examples.

Quick Start

Frontend Login:

<x-demo-login-banner type="user" />

Filament Admin Login:

# Windows PowerShell
Copy-Item "vendor\programmernomad\laracorekit-demo-module\stubs\filament-login.blade.php" `
         -Destination "resources\views\filament\pages\auth\login.blade.php"

Blade Components

Login Page Banner

Add to your login view:

<x-demo-login-banner type="user" />

For admin login:

<x-demo-login-banner type="admin" />

This displays credentials when demo mode is active.

Security Features

Domain Validation

In production, demo mode only works on whitelisted domains (configured in config/demo.php).

Action Blocking

Destructive actions are automatically blocked via Laravel Gates:

// Example: This will be denied in demo mode
Gate::allows('user.delete'); // returns false

Middleware Protection

Apply middleware to routes that should block actions:

Route::middleware('demo.block')->group(function () {
    // Protected routes
});

What Gets Reset?

Every reset cycle cleans:

Database: Fresh migrations + seeders
Media Files: storage/app/public/media/*
Cache: All cached data
Sessions: Active user sessions
Logs: Rotated (keeps last 7 days)

Preserved:

.env configuration
Compiled assets (public/build/*)
Vendor packages
Node modules

Troubleshooting

Cron Not Running

Check if Laravel scheduler is working:

php artisan schedule:list

You should see demo:reset scheduled.

Demo Banner Not Showing

Clear config cache:

php artisan config:clear
php artisan view:clear

Verify .env:

php artisan tinker
>>> config('demo.enabled') // Should return true

Reset Fails

Check logs:

tail -f storage/logs/laravel.log

Run manually with verbose output:

php artisan demo:reset --force -vvv

Media Files Not Deleting

Check permissions:

ls -la storage/app/public/media/
chmod -R 775 storage/app/public/media/

Development

Local Development

Clone and link locally:

# Clone repo
git clone https://github.com/programmernomad/laracorekit-demo-module.git

# In your Laravel project's composer.json
{
    "repositories": [
        {
            "type": "path",
            "url": "../aracorekit-demo-module",
            "options": {
                "symlink": true
            }
        }
    ],
    "require-dev": {
        "programmernomad/laracorekit-demo-module": "@dev"
    }
}

# Install
composer update programmernomad/laracorekit-demo-module

Validation

Run composer validate --strict. This package currently defines no Composer test/style scripts. Validate resets, host restrictions and blocked actions in a disposable Laravel integration application before releasing changes.

Changelog

Please see CHANGELOG.md for recent changes.

Contributing

Open a pull request with a reproducible change and appropriate validation.

Security

Report sensitive issues through the LaraCoreKit security reporting policy rather than posting exploitable details in public.

Credits

License

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

Support

Issues: GitHub Issues
Discussions: GitHub Discussions
Documentation: Full Setup Guide

Related Projects

LaraCoreKit - Laravel 13 starter kit with modular architecture
Demo Website - Live demo powered by this module

Made for the Laravel community

programmernomad / laracorekit-demo-module

Package info

Security

Statistics

README

Looking for the LaraCoreKit starter bundle?

Features

Use Cases

Requirements

Installation

Configuration

Step 1: Publish Configuration

Step 2: Update .env

Step 3: Setup Cron Job

Usage

Enable Demo Mode

Manual Database Reset

Disable Demo Mode

Customization

Change Reset Interval

Add Custom Blocked Actions

Customize Banner Appearance

Domain Whitelisting (Security)

Integration with Filament

Display Demo Banner in Admin Dashboard

UI Integration

Quick Start

Blade Components

Login Page Banner

Security Features

Domain Validation

Action Blocking

Middleware Protection

What Gets Reset?

Troubleshooting

Cron Not Running

Demo Banner Not Showing

Reset Fails

Media Files Not Deleting

Development

Local Development

Validation

Changelog

Contributing

Security

Credits

License

Support

Related Projects

Step 2: Update `.env`