README

A Laravel application starter kit.

About Stickler

Stickler website and custom CMS built with Laravel and Filament.

Stickler provides a ready-to-use foundation for building content-driven Laravel websites with a custom Filament admin panel. It includes structured content management, user roles and permissions, media handling, tags, settings, activity logging, health checks, backups, sitemap generation, spam protection, cookie consent, response caching, and developer tooling for testing, debugging, and code quality.

The starter kit is designed to give new projects a strong production-ready baseline while still being easy to customize for each website or application.

Bootstrap frontend toolkit is used for styling the public views.

Installing Stickler

Laravel Installer

The easiest way to install this starter kit is using the Laravel Installer. This will set up the project automatically.

laravel new my-app --using=voorhof/stickler

After installation, update the variables, such as APP_NAME and APP_URL, in the .env file so that they match your environment.

You can also set RESPONSE_CACHE_ENABLED to true (not required for development, but useful for production)

APP_NAME=Stickler
APP_URL=https://stickler.test

RESPONSE_CACHE_ENABLED=true

You can log in to the Filament admin dashboard via /admin using the login details defined in .env:

email: admin@example.com
password: password

Custom installation

You may also install Stickler manually by cloning the repository and running the following commands:

git clone https://github.com/voorhof/stickler.git my-app
cd my-app
composer install
cp .env.example .env
php artisan key:generate
php artisan migrate

Make sure you have all this covered:

composer install
npm install
storage symlink
database creation
migration & test data seeding
PhpStorm settings (or other editor)
update art in public folder (and references to the logo's inside blade views)
re-generate llms.txt to fit your project

Filament CMS

A separate documentation file is available for the Filament CMS implementation:
FILAMENT.md

Package Dependencies

All vendor packages used in this project are installed with Composer.

Laravel Boost

Documentation
GitHub

This package is for adding AI skills to the Junie assistant and other agents. AI skills are already included in this repository and are used automatically by the assistant.

php artisan boost:update --discover --ansi --no-interaction

Updating the boost command for the skills is automatically configured in composer.json inside the "post-update-cmd".

Laravel Telescope

Documentation
GitHub

Laravel Telescope makes a wonderful companion to your local Laravel development environment. Telescope provides insight into the requests coming into your application, exceptions, log entries, database queries, queued jobs, mail, notifications, cache operations, scheduled tasks, variable dumps, and more.

Service Provider was published to app/providers/TelescopeServiceProvider.

Migration file was published to 0001_01_01_000007_create_telescope_entries_table.php.

Config file was published to config/telescope.php.

Environment variables were added to .env file that are used inside the config file, with default values:

TELESCOPE_ENABLED=true
TELESCOPE_PATH=admin/telescope

Access to Telescope is restricted in production by default for users with the access telescope permission.
This is defined in the gate() method of the TelescopeServiceProvider:

protected function gate(): void
{
    Gate::define('viewTelescope', function (User $user) {
        return $user->can('access telescope');
    });
}

Data pruning is scheduled to run daily by default.
This is defined in the routes/console.php file:

Schedule::command('telescope:prune')
    ->daily();

Spatie Sluggable

Documentation
GitHub

This package is used to generate route slugs for models.

The config file is located in config/sluggable.php.

The #[Sluggable()] attribute is added to models to automatically generate slugs when they are created, for example, in the User model:

#[Sluggable(
    from: 'name',
    to: 'slug',
    separator: '-',
    language: 'nl',
    maxLength: 48,
    unique: true,
    onUpdate: false,
)]

A model must override the getRouteKeyName method within its class, so that route binding works based on the slug rather than the ID:

/**
 * Get the route key for the model.
 */
public function getRouteKeyName(): string
{
    return 'slug';
}

Spatie Permission

Documentation
GitHub

This package is used to manage user permissions and roles. Create new roles in the Filament admin environment and assign permissions to them.

The User model has this trait:

use HasRoles;

We extendened the default Spatie Role and Permission models to our own app Role and Permission models inside the app/models folder. This is helpful for managing roles and permissions inside Filament (RoleResource).

For this to work, the permission config file was updated to use our own models:

'permission' => App\Models\Permission::class,
'role' => App\Models\Role::class,

Config file was published to config/permission.php.

Migration file was published to database/migrations/0002_01_01_000000_create_permission_tables.php.

A custom seeder AdminUserAndRoleSeeder.php was created to seed the permissions and roles, and create a default admin user.

A "Super Admin" role needs no permissions set in the database, access is automatically granted because of the Gate::before() added in the boot method of the AccessServiceProvider:

    public function boot(): void
    {
        // Implicitly grant the "Super Admin" role all permissions
        // This works in the app by using gate-related functions like auth()->user->can() and @can()
        Gate::before(function (User $user) {
            return $user->hasRole('Super Admin') ? true : null;
        });
    }

Note: The ‘Super Admin’ role is not created or pre-configured by default. Please exercise caution when using this role. If it is not required for the application, you can remove the Gate from the boot method.

Spatie Media Library

Documentation
GitHub

This package is used to manage media files and associate media with models.

Config file was published to config/media-library.php.

Migration file was published to 0004_01_01_000000_create_media_table.php.

Views with the rendered HTML components were published to resources/views/vendor/media-library.

Environment variables were added to .env file that are used inside the media-library.php and filesystems.php configuration files:

MEDIA_DISK=media
MEDIA_DISK_DRIVER=local
MEDIA_DISK_ROOT_PATH=app/public/media
MEDIA_DISK_URL_PATH=storage/media
MEDIA_DISK_VISIBILITY=public
MEDIA_DISK__THROW=false
MEDIA_DISK_REPORT=false
MEDIA_QUEUE=media
MEDIA_PREFIX=library
IMAGE_DRIVER=imagick
FFMPEG_PATH="C:/ffmpeg/bin/ffmpeg.exe"
FFPROBE_PATH="C:/ffmpeg/bin/ffprobe.exe"

To associate media with a model, the model must implement the following interface and trait:

use Spatie\MediaLibrary\HasMedia;
use Spatie\MediaLibrary\InteractsWithMedia;

class YourModel extends Model implements HasMedia
{
    use InteractsWithMedia;
}

Extra configuration can be defined inside the model, registering media conversions for example, in the User model:

public function registerMediaConversions(?Media $media = null): void
{
    $this->addMediaConversion('preview')
        ->fit(Fit::Contain, 200, 200)
        ->nonQueued()
        ->deferred()
        ->performOnCollections('avatar', 'images', 'videos', 'documents')
        ->pdfPageNumber(1)
        ->extractVideoFrameAtSecond(1);

    $this->addMediaConversion('thumb')
        ->fit(Fit::Contain, 40, 40)
        ->nonQueued()
        ->deferred()
        ->performOnCollections('avatar', 'images', 'videos', 'documents')
        ->pdfPageNumber(1)
        ->extractVideoFrameAtSecond(1);
}

A new Media model was created inside the app/models folder that extends the default SpatieMedia model. This allows you to add your own methods, add relationships and so on.

namespace App\Models;

use Spatie\MediaLibrary\MediaCollections\Models\Media as BaseMedia;

class Media extends BaseMedia
{
    //
}

Image conversions

The media library has built-in support to convert images. To generate conversions of other media types – most notably PDFs and videos – the medialibrary uses image generators to create a derived image file of the media.

The PDF generator requires Imagick, Ghostscript, and Spatie PDF to Image.

The Video generator requires the PHP-FFMpeg package (in composer.json).

More info and documentation is available here.

Filament Plugin

The Filament plug-in for uploading media from the admin panel to Spatie Media Library is also installed in composer.json. Plugin documentation is available here.

"filament/spatie-laravel-media-library-plugin": "^5.7",

Filament RichEditor implementation

https://filamentphp.com/plugins/filament-spatie-media-library#using-media-library-for-rich-editor-file-attachments

We use media library to store file attachments from the rich editor. To do this, we register a rich content attribute on the model, similar to how a media library collection is registered.

Calling fileAttachmentProvider() on the attribute registration, passing in a SpatieMediaLibraryFileAttachmentProvider::make() object.

We also added a 'content' media collection.

use Filament\Forms\Components\RichEditor\FileAttachmentProviders\SpatieMediaLibraryFileAttachmentProvider;
use Filament\Forms\Components\RichEditor\Models\Concerns\InteractsWithRichContent;
use Filament\Forms\Components\RichEditor\Models\Contracts\HasRichContent;

class Post extends Model implements HasRichContent
{
    use InteractsWithRichContent;

    public function registerMediaCollections(): void
    {
        // ... other media collections

        // Rich content collection
        $this->addMediaCollection('content')
            ->useDisk(config('media-library.disk_name'))
            ->withResponsiveImages();
    }
    
    public function setUpRichContent(): void
    {
        $this->registerRichContent('content')
            ->fileAttachmentProvider(SpatieMediaLibraryFileAttachmentProvider::make());
    }
}

Rich Content Media Synchronization & Alt Text Management

When using Filament's RichEditor with media library file attachments, we manage two key synchronization directions:

Alt Text Synchronization: Copying the alt text entered in the upload/attach modal into the Spatie Media Library media.name column when a model is saved.
Reverse Image Deletion: Automatically removing the corresponding <img> tag from the model's rich content attributes when a media record in the content collection is deleted.

To achieve this cleanly and reusable across models, we implemented a robust architecture consisting of a pure HTML parser support class, dedicated Action classes, observer traits, and model observers.

1. `RichContentImages` Support Class

Located at app/Support/RichContent/RichContentImages.php, this class provides pure, side-effect-free helper methods:

altByUuid(): Parses HTML content using DOMDocument, extracts all <img> tags with valid media UUIDs (data-id), and maps their UUIDs to their alt text.
removeImageByUuid(): Safely removes any rich-content <img> tag matching the given media UUID and cleans up any empty wrapping <p> tags.

2. Actions (`SyncImageAltToMediaName` & `RemoveImageFromRichContent`)

SyncImageAltToMediaName (app/Actions/RichContent/SyncImageAltToMediaName.php): Accepts any model implementing HasMedia and rich-content attributes to scan, syncing image alt text to matching Media record names.
RemoveImageFromRichContent (app/Actions/RichContent/RemoveImageFromRichContent.php): Accepts a model and a media UUID, removing the matching image tag from the model's rich content attributes using RichContentImages::removeImageByUuid() and saving quietly.

3. `SyncsRichContentImageAltText` Trait

Located at app/Observers/Traits/SyncsRichContentImageAltText.php, this trait provides a helper method syncImageAltToMediaName() for observers to easily invoke the alt sync action.

4. Observers (`PostObserver` & `MediaObserver`)

PostObserver: Uses SyncsRichContentImageAltText to sync image alt texts inside the saved() event handler.
MediaObserver: Listens to the deleted event on media records. When a media item belonging to the content collection is deleted, it resolves the parent model and invokes RemoveImageFromRichContent.

For models with multiple rich-content fields, pass an array of attribute names:

$this->syncImageAltToMediaName($recipe, ['content', 'method']);

Spatie Tags

Documentation
GitHub

This package allows you to add tags to models. Laravel Tags comes ready to use. It offers built-in support for translating tags, multiple tag types, and sorting options.

The Config file is published in config/tags.php.

The Migration file is published in 0005_01_01_000000_create_tag_tables.php.

To add tags to an Eloquent model, we have added the HasTags trait to it:

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Spatie\Tags\HasTags;

class Post extends Model
{
    use HasTags;
    
    // ...
}

We have extended the standard Spatie Tag model to create our own Tag model in the app/models folder. This helps the Filament CMS to manage tags, use SoftDeletes and log activities.

To make this work, the configuration file tags.php has been modified to use our own Tag model:

'tag_model' => \App\Models\Tag::class,

The official Filament Plugin is also installed via composer: https://filamentphp.com/plugins/filament-spatie-tags

Spatie Eloquent Sortable

GitHub

This package provides a trait that allows an Eloquent model to be sorted. The package also provides a query scope to retrieve all records in the correct order.

Config file was published to config/eloquent-sortable.php.

The trait SortableTrait has been added and the interface Sortable has been implemented in models such as Message, Role, User, …, to enable sorting.

A custom trait, SortableOnUpdate, has also been added, so that records are re-sorted when the ‘order_column’ for a single record is changed, or when a new record is created.

use App\Traits\SortableOnUpdate;
use Spatie\EloquentSortable\Sortable;
use Spatie\EloquentSortable\SortableTrait;

class Post extends Model implements Sortable
{
    use SortableOnUpdate;
    use SortableTrait;

    // ...
}

The Media model can also be sorted, but the trait has been implemented slightly differently, to ensure compatibility with the Media::scopeOrdered method from the Spatie Media Library.

The scopeOrdered method is overridden in the model to return a Builder with a direction parameter:

use Illuminate\Database\Eloquent\Builder;
use Spatie\EloquentSortable\Sortable;
use Spatie\EloquentSortable\SortableTrait;
use Spatie\MediaLibrary\MediaCollections\Models\Media as BaseMedia;

class Media extends BaseMedia implements Sortable
{
    use SortableTrait {
        scopeOrdered as traitScopeOrdered;
    }

    public function scopeOrdered($query, string $direction = 'asc'): Builder
    {
        return $this->traitScopeOrdered($query, $direction);
    }
}

All sortable models have an ‘order_column’ in the corresponding database migration file:

$table->unsignedInteger('order_column')->nullable()->index();

For pages containing Filament lists, there is a trait called HasOrderTableDefaults, which can be used to override the reorderTable method, so that the updated_at column is preserved and is not altered during reordering.

Sortable models can be reordered on the list page of the Filament admin panel by clicking the button at the top left of the table (up/down arrow).

Spatie Settings

GitHub

This package allows us to store settings in the database and use them throughout the application.

Config file was published to config/settings.php.

Migration file was published to 0001_01_01_000006_create_settings_table.php.

Classes for settings are placed inside the app/Settings folder and must extend the Spatie\LaravelSettings\Settings class.

namespace App\Settings;

use Spatie\LaravelSettings\Settings;

class GeneralSettings extends Settings
{
    public static function group(): string
    {
        return 'general';
    }
}

We can add typed properties to the settings class and also make them nullable:

public ?string $google_maps_api_key;

You can generate a new settings class using this artisan command. Before you do, please check if the setting_class_path is correctly set. You can also specify a path option, which is optional.

php artisan make:setting GeneralSettings --group=general

Each settings class must be registered inside the settings.php config file so it can be loaded by Laravel.

'settings' => [
    GeneralSettings::class,
    TermsSettings::class,
],

Default values are set in migration files in the database/settings folder for each different setting group.

use Spatie\LaravelSettings\Migrations\SettingsMigration;

return new class extends SettingsMigration
{
    public function up(): void
    {
        $this->migrator->add('general.contact_name', config('stickler.contact_details.name'));
        $this->migrator->add('general.contact_address', config('stickler.contact_details.address'));
        $this->migrator->add('general.contact_city', config('stickler.contact_details.city'));
        $this->migrator->add('general.contact_country', config('stickler.contact_details.country'));
        $this->migrator->add('general.contact_company_name', config('stickler.contact_details.company_name'));
        $this->migrator->add('general.contact_company_number', config('stickler.contact_details.company_number'));
        $this->migrator->add('general.contact_email', config('stickler.contact_details.email'));
        $this->migrator->add('general.contact_phone', config('stickler.contact_details.phone'));
        $this->migrator->add('general.social_facebook', config('stickler.social_links.facebook'));
        $this->migrator->add('general.social_instagram', config('stickler.social_links.instagram'));
        $this->migrator->add('general.social_linkedin', config('stickler.social_links.linkedin'));
    }
};

Environment variables were added to .env file that are used inside the configuration file:

SETTINGS_CACHE_ENABLED=true
SETTINGS_CACHE_MEMO=true

The official Filament Plugin is also installed via composer:
https://filamentphp.com/plugins/filament-spatie-settings
https://github.com/filamentphp/spatie-laravel-settings-plugin

All setting Pages are created inside the app\Filament\Pages\Spatie\Settings folder.

A custom trait HasSettingsPageDefaults was created and is used by all settings Pages

Spatie Activity Log

Documentation
GitHub

This package offers user-friendly features for recording user activities within the app. It also automatically records model events. All activities are stored in the activity_log table.

Config file was published to config/activitylog.php.

Migration file was published to 0001_01_01_000003_create_activity_log_table.php.

HasActivity Trait was added to the User model to make it possible to log its activities. All other models that need their activities logged use the Spatie\Activitylog\Traits\LogsActivity trait.

In the app/models folder, an Activity model has been created extending the standard Spatie Activity model. This means it can be used as a Filament resource and that you can add your own methods to it, such as custom filters or additional data processing.

You can log activities manually by calling the activity() helper function:

// Basic logging
activity()->log('Look mum, I logged something');

// Log model activity
activity()
    ->causedBy($userModel)
    ->performedOn($someContentModel)
    ->log('created');
    
// Log model activity (shorter 'by' and 'on' alias)
activity()
    ->by($userModel)
    ->on($someContentModel)
    ->log('created');

If you're not using causedBy() or by(), the package will automatically use the logged-in user, so you can do leave it out and write only this shorter code:

// Log activity
activity()->on($someContentModel)->log('created');

Another example with setting a custom event name:

// Log activity
activity()
    ->causedBy($userModel)
    ->performedOn($someContentModel)
    ->event('created')
    ->log('Created a new content item');

// Short alias version
activity()
    ->on($someContentModel)
    ->event('created')
    ->log('Created a new content item');

// Inside a Filament action method, f.e. afterCreate()
activity()
    ->on($this->record)
    ->event('created')
    ->log('Created a new Post');

Set custom properties on the activity log:

activity()
   ->causedBy($userModel)
   ->performedOn($someContentModel)
   ->withProperties(['key' => 'value'])
   ->log('edited');

Logging model events

The package can automatically log events such as when a model is created, updated and deleted. To make this work, all you need to do is let your model use the Spatie\Activitylog\Models\Concerns\LogsActivity trait.

use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\LogsActivity;

class Post extends Model
{
    use LogsActivity;
}

CausesActivity and HasActivity traits

The package ships with a Spatie\Activitylog\Models\Concerns\CausesActivity trait that can be added to a (User) model. Since User both causes and logs activities (common for User models), we used the HasActivity trait instead. This combines LogsActivity and CausesActivity and provides these three relationships:

activities() returns activities where this model is the subject (alias for activitiesAsSubject())
activitiesAsSubject() returns activities where this model is the subject
activitiesAsCauser() returns activities where this model is the causer

You can retrieve all the current user's activities like this:

Auth::user()->activitiesAsCauser;

LogsTrashedActivity trait

A custom LogsTrashedActivity trait was created to change the default event name from Spatie Activitylog to 'trashed' when soft deleting. It keeps the event name 'deleted' when removing a model permanently.

Cleaning up old activity logs

After using the package for a while, you might have recorded a lot of activity. This package provides an artisan command activitylog:clean to clean the log. Running this command will result in the deletion of all recorded activity that is older than the number of days specified in the clean_after_days key of the config file.

php artisan activitylog:clean

A schedule command is registered inside console.php to run daily

Schedule::command('activitylog:clean --force')
    ->daily();

Spatie Sitemap

Documentation
GitHub

This package can generate a sitemap without you having to add URLs to it manually. This works by crawling your entire site.

Config file was published to config/sitemap.php.

An Artisan command files was created in app/Console/Commands/GenerateSitemap.php for generating the sitemap.

A controller was created inside app/Http/Controllers/Filament/SitemapController.php for generating the sitemap from inside the Filament admin panel.

The route to the controller was registered inside routes/filament.php and a link to the route was added to the StickerWidget view stickler-widget.blade.php used the admin dashboard.

A sitemap link is also added in the head section of the app layout:

<link rel="sitemap" type="application/xml" title="Sitemap" href="{{ Storage::url('sitemap.xml') }}">

Spatie Health

Documentation
GitHub

Using this package, we can monitor the health of the application.

Config file was published to config/health.php.

Migration file was published to 0001_01_01_000005_create_health_tables.php.

HealthServiceProvider was created inside the app/providers folder to register the required health checks.

Schedule health checks to run 15 minutes, defined inside routes/console.php:

/**
 * Run health checks every 15 minutes
 */
Schedule::command(RunHealthChecksCommand::class)
    ->everyFifteenMinutes();
// Dispatch a very light job on the queue you wish to monitor.
Schedule::command(DispatchQueueCheckJobsCommand::class)
    ->everyMinute();
// Set the heartbeat for the schedule health check.
Schedule::command(ScheduleCheckHeartbeatCommand::class)
    ->everyMinute();
// Prune the health check results daily and only keep history of the last 7 days (defined in config health.php)
Schedule::command('model:prune', ['--model' => [HealthCheckResultHistoryItem::class]])
    ->daily();

A Filament Health page was created inside app/Filament/Pages/Spatie/ to display the health check results. This page uses the HealthStatusIndicator component with corresponding view in resources/views/components/health-status-indicator.blade.php.

A custom HealthCheckAction was created inside app/Actions/HealthCheckAction.php to run the health check manually.

The RunHealthChecksCommand::class is registered inside bootstrap/app.php.

Spatie Backup

Documentation
GitHub

This package is used to create backups of the application. Backups are zipfiles that contain all the folders we specify, along with a dump of the database.

Config file was published to config/backup.php and a new 'backups' disk is configured inside the config/filesystems.php file.

Translation files were published to lang/vendor/backup.

Environment variables were added to .env file that are used inside the backup.php and filesystems.php configuration files:

BACKUP_ARCHIVE_PASSWORD="password"
BACKUP_DISK=backups
BACKUP_DISK_DRIVER=local
BACKUP_DISK_ROOT_PATH=app/private/backups
BACKUP_DISK_URL_PATH=storage/backups
BACKUP_DISK_VISIBILITY=private
BACKUP_DISK__THROW=false
BACKUP_DISK_REPORT=false

A Filament page inside Filament/Pages/Spatie was created for creating and managing backups from the admin panel,
Together with the BackupService for handling data.

A BackupServiceProvider was created to handle the backup event listening.

Permissions were added to access, download, create, delete backups inside the PermissionSeeder.php file.

A scheduled job was added inside the routes/console.php file to automatically create new backups and clean up old backups (daily).

Schedule::command('backup:clean')
    ->daily();
Schedule::command('backup:run --only-db --filename=db-'.app()->environment().'-'.date(config('backup.backup.database_dump_file_timestamp_format')).'.zip')
    ->daily();
Schedule::command('backup:run --only-files --filename=files-'.app()->environment().'-'.date(config('backup.backup.database_dump_file_timestamp_format')).'.zip')
    ->weeklyOn(Illuminate\Console\Scheduling\Schedule::SUNDAY);

Spatie Honeypot

GitHub

This package is used for preventing spam submitted through forms.

Config file is published in config/honeypot.php.

View file is published in resources/views/vendor/honeypot/honeypotFormFields.blade.php.

Environment variables are added to .env file and used inside the config file, with default values:

HONEYPOT_ENABLED=true
HONEYPOT_NAME="first_name"
HONEYPOT_RANDOMIZE=true
HONEYPOT_VALID_FROM_TIMESTAMP=true
HONEYPOT_VALID_FROM="valid_from"
HONEYPOT_SECONDS=1

Add the x-honeypot Blade component to any form you wish to protect:

<!--suppress CheckEmptyScriptTag -->
<form action="{{ route('contact.store') }}" method="POST">
    <x-honeypot />
</form>

Next, you must use the Spatie\Honeypot\ProtectAgainstSpam middleware in the route that handles the form submission. This middleware will intercept any request that submits a non-empty value for the HONEYPOT_NAME env key used inside the config file.

It will also intercept the request if it is submitted faster than the encrypted timestamp that the package generated in valid_from_timestamp:

use App\Http\Controllers\Public\ContactController;
use Illuminate\Support\Facades\Route;
use Spatie\Honeypot\ProtectAgainstSpam;

Route::post('/contact', [ContactController::class, 'store'])
    ->name('contact.store')
    ->middleware(ProtectAgainstSpam::class);

Spatie Cookie Consent

GitHub
Blog

This package adds a simple, customizable cookie consent message to the website. When the site loads, the banner appears and lets users consent to cookies. Once consent is given, the banner hides and stays hidden.

Config file is published in config/cookie-consent.php.

View files are published in resources/views/vendor/cookie-consent.

Translation files were published to lang/vendor/cookie-consent.

Environment variable is added to .env file and used inside the config file, with default value:

COOKIE_CONSENT_ENABLED=true

Inside the app.blade.php layout file the cookie consent banner is included:

@include('cookie-consent::index')

Spatie Response Cache

Documentation GitHub

The first time a request comes in, the package will save the response before sending it to the user. When the same request comes in again, the cached response is returned without going through the entire application. This will greatly speed up your app.

By default, the package will now cache all successful GET requests that return text based content (such as HTML and JSON) for a week.

Config file is published in config/responsecache.php.

Inside the bootstrap/app.php file the CacheResponse middleware and the DoNotCacheResponse alias are added:

use Spatie\ResponseCache\Middlewares\CacheResponse;
use Spatie\ResponseCache\Middlewares\DoNotCacheResponse;

->withMiddleware(function (Middleware $middleware) {
    $middleware->web(append: [
        CacheResponse::class,
    ]);

    $middleware->alias([
        'doNotCacheResponse' => DoNotCacheResponse::class,
    ]);
})

Inside the ContactController we added the #[NoCache] attribute to the index and store method, so the response will not be cached and the success message will be shown.

More configuration is possible, for now this project is using the default settings.

Spatie HTTP Logger

GitHub Blog

This package adds a middleware which can log incoming requests to the default log. If anything goes wrong during a user's request, you'll still be able to access the original request data sent by that user. Log entries can be viewed in OPcodes Log Viewer (see documentation below).

Config file is published in config/http-logger.php.

Environment variables 'HTTP_LOGGER_ENABLED' and 'HTTP_LOGGER_CHANNEL' are added to .env file and used inside the config file, with default values:

HTTP_LOGGER_ENABLED=true
HTTP_LOGGER_CHANNEL=http

Pre-existing environment variables for the logging settings inside config files, with default values:

LOG_CHANNEL=stack
LOG_STACK=single
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug

We added a custom Log Channel to the log configuration in config/logging.php to log the HTTP requests:

'channels' => [
    // ...
    
    'http' => [
        'driver' => 'single',
        'path' => storage_path('logs/http-logger.log'),
        'level' => env('LOG_LEVEL', 'debug'),
        'replace_placeholders' => true,
    ],
    
    // ...
],

Middleware is provided by this package and can be added as global middleware inside the bootstrap/app.php file:

->withMiddleware(function (Middleware $middleware) {
    $middleware->append(\Spatie\HttpLogger\Middlewares\HttpLogger::class);
})

For this project, we only added this middleware to specific POST routes inside routes/web.php:

use Spatie\HttpLogger\Middlewares\HttpLogger;

Route::post('/contact', [ContactController::class, 'store'])
    ->name('contact.store')
    ->middleware(HttpLogger::class);

OPcodes Log Viewer

Documentation
GitHub

Log Viewer is a package allowing you to easily read, search and manage your Laravel logs.
You will no longer need to read the raw log files trying to find what you're looking for.

Config file was published to config/log-viewer.php.

Environment variables were added to .env file that are used inside the config file, with default values:

LOG_VIEWER_ENABLED=true
LOG_VIEWER_API_ONLY=false

The Log Viewer can be accessed at URI admin/log-viewer.
Access is restricted by default for users with the access logs permission.

Inside the default AuthorizeLogViewer middleware from log-viewer is an existence check for Gate::has('viewLogViewer').
We defined this viewLogViewer Gate inside the boot method of the AccessServiceProvider to check for the permission:

namespace App\Providers;

use App\Models\User;
use Illuminate\Support\Facades\Gate;
use Illuminate\Support\ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        // Grant access to the Log Viewer when the user has the "access log-viewer" permission
        // https://log-viewer.opcodes.io/docs/3.x/configuration/access-to-log-viewer#via-viewlogviewer-gate
        Gate::define('viewLogViewer', function (User $user) {
            return $user->can('access log-viewer');
        });
    }
}

We can also restrict certain additional permissions, such as granting access to individual log files or downloading and deleting log files:

Gate::define('downloadLogFile', function (User $user) {
    return $user->can('download logs');
});

Gate::define('deleteLogFile', function (User $user) {
    return $user->can('delete logs');
});

More info is available in the documentation.

Front-end assets

Front-end assets can be published to public/vendor/log-viewer folder, using the artisan command:

php artisan log-viewer:publish

Note: Publishing assets is no longer required. Assets are now served directly from the vendor directory. This option only applies if you have already published older assets using php artisan log-viewer:publish.
This option will be removed in the next major version of the package.

Testing

To test the application and run all tests included in the tests directory, run the following command:

php artisan test --compact --parallel

You can also execute Pest directly in the terminal:

./vendor/bin/pest

Code Style

Laravel Pint is used to check the code style, run the following command before committing:

./vendor/bin/pint

Security Vulnerabilities

If you discover a security vulnerability within Stickler, please send an e-mail to David Carton via david@notrac.be. All security vulnerabilities will be promptly addressed.

License

Stickler is open-sourced software licensed under the MIT license.

voorhof / stickler

Package info

Security

Statistics

README

About Stickler

Installing Stickler

Laravel Installer

Custom installation

Filament CMS

Package Dependencies

Laravel Boost

Laravel Telescope

Spatie Sluggable

Spatie Permission

Spatie Media Library

Image conversions

Filament Plugin

Filament RichEditor implementation

Rich Content Media Synchronization & Alt Text Management

1. RichContentImages Support Class

2. Actions (SyncImageAltToMediaName & RemoveImageFromRichContent)

3. SyncsRichContentImageAltText Trait

4. Observers (PostObserver & MediaObserver)

Spatie Tags

Spatie Eloquent Sortable

Spatie Settings

Spatie Activity Log

Logging model events

CausesActivity and HasActivity traits

LogsTrashedActivity trait

Cleaning up old activity logs

Spatie Sitemap

Spatie Health

Spatie Backup

Spatie Honeypot

Spatie Cookie Consent

Spatie Response Cache

Spatie HTTP Logger

OPcodes Log Viewer

Front-end assets

Testing

Code Style

Security Vulnerabilities

License

1. `RichContentImages` Support Class

2. Actions (`SyncImageAltToMediaName` & `RemoveImageFromRichContent`)

3. `SyncsRichContentImageAltText` Trait

4. Observers (`PostObserver` & `MediaObserver`)