> For the complete documentation index, see [llms.txt](https://core-foundation-doc.rupeshstha.com.np/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://core-foundation-doc.rupeshstha.com.np/installation.md).

# Installation

Core Foundation is designed to be easily integrated into any Laravel application.

## Requirements

* PHP 8.3 or higher
* Laravel 11.x or higher

## Installation

You can install the package via composer:

```bash
composer require rupeshstha/core-foundation
```

## Configuration

The package will automatically register its service provider. To customize the foundation, you should publish the configuration file:

```bash
php artisan vendor:publish --tag="core-foundation"
```

This will create a `config/core-foundation.php` file where you can configure:

* Default pagination limits
* Cache TTLs
* Event prefixes
* APM settings
* Middleware for the built-in feature flag routes (`auth.features_middleware`)

## Database Migrations

The package may include migrations for internal tracking or optional features. You can run them using:

```bash
php artisan migrate
```

## Octane Compatibility

Core Foundation is fully compatible with Laravel Octane. It avoids static state pollution and ensures that all service bindings and context management are request-scoped where necessary.
