Installation

Installation

Requirements

• PHP 8.4 or higher
• Laravel 12.0 or higher
• A configured database connection

Install via Composer

Install the package using Composer:

composer require romegasoftware/availability

The service provider will auto-register with Laravel's package discovery.

Database Setup

Run the migrations to create the availability rules table:

php artisan migrate

This creates the availability_rules table with the following structure:

• Polymorphic relationship columns (subject_type, subject_id)
• Rule configuration (type, config, effect)
• Management fields (priority, enabled)
• Standard timestamps

Optional: Publish Configuration

If you need to customize the package configuration:

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

This publishes the configuration file to config/availability.php.

Optional: Publish Migrations

If you need to customize the migration:

php artisan vendor:publish --tag=availability-migrations

This allows you to:

• Change the table name
• Add custom columns
• Modify indexes

Note: If you customize the table name, update the table value in your config file.

Optional: Publish Boost AI Helper

If your project uses Laravel Boost for AI-assisted workflows, publish the packaged .ai helper files so Boost can load the availability guidelines:

php artisan vendor:publish --tag=availability-ai

Note: Run php artisan boost:install after publishing the AI helper.

Re-run the command with the --force flag any time you want to refresh the helper files after updating the package.

Verify Installation

Test that everything is working:

use RomegaSoftware\Availability\Support\AvailabilityEngine;

$engine = app(AvailabilityEngine::class);
dd($engine); // Should return the engine instance

Next Steps

• Quick Start - Get your first availability rules working
• Configuration - Understand configuration options
• Basic Usage - Learn common patterns