Search by

hitaqnia / haykal

mahdi-mk

Haykal metapackage: installs haykal-api + haykal-filament for full-stack projects.

Package info

github.com/hitaqnia/haykal

Type:metapackage

pkg:composer/hitaqnia/haykal

Statistics

Installs: 132

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v3.1.0 2026-09-14 08:57 UTC

This package is auto-updated.

Last update: 2026-09-16 15:25:06 UTC


README

Metapackage for full-stack HiTaqnia Laravel applications.

hitaqnia/haykal is a convenience entry point that installs the two runtime packages in the Haykal suite at once: hitaqnia/haykal-api (API layer, Scramble integration, ApiProvider composition) and hitaqnia/haykal-filament (Filament base classes, shared theme). Both packages transitively install hitaqnia/haykal-core, so a single composer require hitaqnia/haykal brings up the entire stack.

This package contains no PHP code of its own.

When to require this package

Require hitaqnia/haykal when the application exposes both an HTTP API and one or more Filament panels — the typical HiTaqnia project shape.

Applications that only expose an API (headless services, microservices without admin panels) should require hitaqnia/haykal-api directly. Applications that only expose Filament panels (internal admin tools without a public API surface) should require hitaqnia/haykal-filament directly. Both flavors pull haykal-core transitively.

Installation

composer require hitaqnia/haykal

After installation, follow each sub-package's own configuration guide — the metapackage does not add configuration of its own:

  1. haykal-core — remove Laravel's default users migration, wire the auth provider to the application's User, publish Spatie permission / Media Library configs, slot middlewares, run migrations.
  2. haykal-api — register an ApiProvider per module, and for the auth toolkit publish haykal-auth.php plus the tokens migration, add the sanctum guard, and mount AuthRoutes::register().
  3. haykal-filament — scaffold a panel theme with php artisan haykal:publish-theme <panel>, define one panel provider per tenant type, and point loginPage() at the application's own login page.

Requirements

  • PHP 8.3 or later
  • Laravel 13 or later
  • Filament 5.5 or later

Versioning

The metapackage tracks the Haykal suite's major version and pins its dependencies to the matching minor range so composer require hitaqnia/haykal:^3.0 resolves consistent versions of the underlying packages. Pin to a concrete version when you need to lock a release; otherwise composer require hitaqnia/haykal always resolves the latest stable.