Download the PHP package dantepiazza/laravel-base without Composer

dantepiazza/laravel-base

Base package for Laravel backend projects. Provides a pre-configured bootstrap/app.php, standardized middleware, structured API responses, webhook handling, error tracking, and API documentation — all publishable via a single command.

Requirements

• PHP 8.3+
• Laravel 11, 12 or 13
• dantepiazza/laravel-api-response ^1.0
• sentry/sentry-laravel ^4.0
• A configured queue driver (Redis recommended) for webhook processing

Installation

Publish all stubs at once:

Or publish individually:

Scribe config is merged from the package by default — no need to publish it unless you need to customize it:

Features

1. Base Controller — dantepiazza/laravel-api-response

This package requires dantepiazza/laravel-api-response and pre-wires it into the base Controller stub. After publishing, every controller in your project gets ApiResponse injected automatically:

Usage in any controller:

2. Middleware

ForceJsonResponse

Forces Accept: application/json on every request so Laravel always returns JSON errors. Register it globally in bootstrap/app.php:

GlobalHeaders

Attaches standard headers to every API response. Register it in bootstrap/app.php:

Headers added to every response:

The X-Correlation-ID is also injected back into the request object so any controller or service can read it:

CacheLastUpdate — runtime-updatable cache invalidation timestamp

SPA clients cache lookup data (categories, settings, etc.) in localStorage and use X-Cache-Last-Update to decide whether to refetch it. Because that needs to change the moment backoffice data changes — not at deploy time — the value isn't config, it's stored in the application cache and updated at runtime:

GlobalHeaders calls CacheLastUpdate::get() automatically on every response — no extra wiring needed.

3. Webhook handling

The package ships a generic WebhookController that receives webhooks from any source, verifies the signature, and dispatches a Laravel event asynchronously.

Route setup

The controller expects a {source} route parameter that identifies the origin:

This dispatches events named webhook.{source}.{event_type}, so each origin is isolated:

Signature verification

By default the controller rejects all requests (verifySignature returns false). To enable a source, extend the controller and override the method:

Then point the route to your controller:

Listening to webhook events

Payload passed to every listener:

4. Exception handling (bootstrap/app.php)

The published bootstrap/app.php includes a full exception handler wired to dantepiazza/laravel-api-response:

Rate limiters included out of the box:

5. GlitchTip / Sentry error tracking

Uses sentry/sentry-laravel, which is fully compatible with GlitchTip. Publish the config and set the DSN:

The X-Correlation-ID on every request can be used to correlate GlitchTip events with specific API calls.

6. Logging

The published config/logging.php includes a pre-configured stack with daily file rotation and optional Slack alerts for critical errors:

7. API Documentation (Scribe)

Scribe is configured out of the box — the package merges its own config/scribe.php automatically, no publishing needed.

To generate docs:

To customize the config for a specific project:

8. Docker

A production-ready Docker setup is included. Publish it with:

Publishes:

docker-compose.yml is the production compose file (uses a pre-built image via APP_IMAGE). docker-compose.override.yml is the local development override — it builds the image from source and mounts the project directory for live reload.

9. CI/CD — GitHub Actions deploy workflow

The package's own repository ships .github/workflows/deploy.yml: on every push to main or development it builds the app image, pushes it to ghcr.io, then SSHes into the target server to pull and restart it. This workflow is for the package's own reference app / VPS — copy it into a consuming project if you want the same pipeline there.

Configure it under the repo's Settings → Secrets and variables → Actions:

None of these values are secret except the SSH key, so they're set as repository variables, not secrets — that keeps them visible/diffable in the Actions UI instead of hidden.

Package structure