=== .ai/settings-and-env-usage rules === # settings and env usage this application has a fast cached settings system for storing configuration in database and accessing environment variables. ## how to use in blade templates ### display database settings - Elvora - shows setting value from database (cached) - 1000 - with default value - - unescaped output ### display environment variables - Workpay - shows config value from .env file - https://workpay.test/ - any config key using dot notation - 1 - unescaped output ### check settings conditionally - - checks if setting equals value - ... - checks if setting exists ## how to use in php code ### get settings - setting('site_name') - get single setting - setting('max_amount', 100) - with default value - all_settings() - get array of all settings - has_setting('site_name') - check if exists ### create or update settings - set_setting('site_name', 'Novira') - creates or updates - set_setting('maintenance_mode', true) - auto-detects boolean - set_setting('max_users', 1000) - auto-detects integer - set_setting('rate', 5.5) - auto-detects float - set_setting('links', array) - auto-detects json ### advanced usage - settings()->get('key') - using service instance - settings()->set('key', 'value') - set via service - settings()->forget('key') - delete setting - settings()->clearCache() - clear cache manually ## where to use ### in blade views use for dynamic content like site name, descriptions, limits, social links, feature toggles ### in controllers use for validation rules, business logic, conditional redirects based on settings ### in livewire components use in mount, computed properties, or actions for reactive settings ### in middleware use for access control, maintenance mode checks, feature flags ### in service classes use anywhere you need configurable values that can change without code deployment ## performance notes - first access loads from database - subsequent requests served from cache for 60 minutes - cache clears automatically when settings updated or deleted - env variables cached by laravel config system - change cache duration in app/Services/SettingsService.php by modifying cacheMinutes property ## managing settings ### via tinker console run "php artisan tinker" then use helper functions like setting(), set_setting(), all_settings() ### via database seeder add new settings to database/seeders/SettingSeeder.php then run "php artisan db:seed --class=SettingSeeder" ### directly in database insert or update rows in settings table with columns: key, value, type, description ## available settings these settings are pre-seeded and ready to use: - site_name - website name - site_description - website tagline or description - maintenance_mode - true/false for site maintenance - max_withdrawal_amount - maximum withdrawal limit - min_withdrawal_amount - minimum withdrawal limit - referral_bonus - referral reward amount - allow_registration - true/false to enable signups - social_links - json object with social media urls ## data types settings automatically cast to correct type: - string - text values returned as-is - boolean - stored as 0/1, returned as true/false - integer - stored as string, returned as number - float - stored as string, returned as decimal - json - stored as json string, returned as php array ## implementation files - database/migrations/2025_11_08_020652_create_settings_table.php - app/Models/Setting.php - app/Services/SettingsService.php - app/Providers/SettingsServiceProvider.php - app/helpers.php - database/seeders/SettingSeeder.php ## examples in blade header: Elvorain blade title: Workpayin controller: if (setting('maintenance_mode')) redirect to maintenance page in livewire: validate amount between setting('min_withdrawal_amount') and setting('max_withdrawal_amount') in middleware: check setting('allow_registration') before showing register form === foundation rules === # Laravel Boost Guidelines The Laravel Boost guidelines are specifically curated by Laravel maintainers for this application. These guidelines should be followed closely to ensure the best experience when building Laravel applications. ## Foundational Context This application is a Laravel application and its main Laravel ecosystems package & versions are below. You are an expert with them all. Ensure you abide by these specific packages & versions. - php - 8.4 - laravel/framework (LARAVEL) - v13 - laravel/octane (OCTANE) - v2 - laravel/prompts (PROMPTS) - v0 - laravel/sanctum (SANCTUM) - v4 - laravel/telescope (TELESCOPE) - v5 - livewire/livewire (LIVEWIRE) - v4 - laravel/boost (BOOST) - v2 - laravel/mcp (MCP) - v0 - laravel/pail (PAIL) - v1 - laravel/pint (PINT) - v1 - laravel/sail (SAIL) - v1 - phpunit/phpunit (PHPUNIT) - v12 - tailwindcss (TAILWINDCSS) - v4 ## Skills Activation This project has domain-specific skills available in `**/skills/**`. You MUST activate the relevant skill whenever you work in that domain—don't wait until you're stuck. ## Conventions - You must follow all existing code conventions used in this application. When creating or editing a file, check sibling files for the correct structure, approach, and naming. - Use descriptive names for variables and methods. For example, `isRegisteredForDiscounts`, not `discount()`. - Check for existing components to reuse before writing a new one. ## Verification Scripts - Do not create verification scripts or tinker when tests cover that functionality and prove they work. Unit and feature tests are more important. ## Application Structure & Architecture - Stick to existing directory structure; don't create new base folders without approval. - Do not change the application's dependencies without approval. ## Frontend Bundling - If the user doesn't see a frontend change reflected in the UI, it could mean they need to run `npm run build`, `npm run dev`, or `composer run dev`. Ask them. ## Documentation Files - You must only create documentation files if explicitly requested by the user. ## Replies - Be concise in your explanations - focus on what's important rather than explaining obvious details. === boost rules === # Laravel Boost ## Tools - Laravel Boost is an MCP server with tools designed specifically for this application. Prefer Boost tools over manual alternatives like shell commands or file reads. - Use `database-query` to run read-only queries against the database instead of writing raw SQL in tinker. - Use `database-schema` to inspect table structure before writing migrations or models. - Use `get-absolute-url` to resolve the correct scheme, domain, and port for project URLs. Always use this before sharing a URL with the user. - Use `browser-logs` to read browser logs, errors, and exceptions. Only recent logs are useful, ignore old entries. ## Searching Documentation (IMPORTANT) - Always use `search-docs` before making code changes. Do not skip this step. It returns version-specific docs based on installed packages automatically. - Pass a `packages` array to scope results when you know which packages are relevant. - Use multiple broad, topic-based queries: `['rate limiting', 'routing rate limiting', 'routing']`. Expect the most relevant results first. - Do not add package names to queries because package info is already shared. Use `test resource table`, not `filament 4 test resource table`. ### Search Syntax 1. Use words for auto-stemmed AND logic: `rate limit` matches both "rate" AND "limit". 2. Use `"quoted phrases"` for exact position matching: `"infinite scroll"` requires adjacent words in order. 3. Combine words and phrases for mixed queries: `middleware "rate limit"`. 4. Use multiple queries for OR logic: `queries=["authentication", "middleware"]`. ## Artisan - Run Artisan commands directly via the command line (e.g., `php artisan route:list`). Use `php artisan list` to discover available commands and `php artisan [command] --help` to check parameters. - Inspect routes with `php artisan route:list`. Filter with: `--method=GET`, `--name=users`, `--path=api`, `--except-vendor`, `--only-vendor`. - Read configuration values using dot notation: `php artisan config:show app.name`, `php artisan config:show database.default`. Or read config files directly from the `config/` directory. - To check environment variables, read the `.env` file directly. ## Tinker - Execute PHP in app context for debugging and testing code. Do not create models without user approval, prefer tests with factories instead. Prefer existing Artisan commands over custom tinker code. - Always use single quotes to prevent shell expansion: `php artisan tinker --execute 'Your::code();'` - Double quotes for PHP strings inside: `php artisan tinker --execute 'User::where("active", true)->count();'` === php rules === # PHP - Always use curly braces for control structures, even for single-line bodies. - Use PHP 8 constructor property promotion: `public function __construct(public GitHub $github) { }`. Do not leave empty zero-parameter `__construct()` methods unless the constructor is private. - Use explicit return type declarations and type hints for all method parameters: `function isAccessible(User $user, ?string $path = null): bool` - Use TitleCase for Enum keys: `FavoritePerson`, `BestLake`, `Monthly`. - Prefer PHPDoc blocks over inline comments. Only add inline comments for exceptionally complex logic. - Use array shape type definitions in PHPDoc blocks. === deployments rules === # Deployment - Laravel can be deployed using [Laravel Cloud](https://cloud.laravel.com/), which is the fastest way to deploy and scale production Laravel applications. === laravel/core rules === # Do Things the Laravel Way - Use `php artisan make:` commands to create new files (i.e. migrations, controllers, models, etc.). You can list available Artisan commands using `php artisan list` and check their parameters with `php artisan [command] --help`. - If you're creating a generic PHP class, use `php artisan make:class`. - Pass `--no-interaction` to all Artisan commands to ensure they work without user input. You should also pass the correct `--options` to ensure correct behavior. ### Model Creation - When creating new models, create useful factories and seeders for them too. Ask the user if they need any other things, using `php artisan make:model --help` to check the available options. ## APIs & Eloquent Resources - For APIs, default to using Eloquent API Resources and API versioning unless existing API routes do not, then you should follow existing application convention. ## URL Generation - When generating links to other pages, prefer named routes and the `route()` function. ## Testing - When creating models for tests, use the factories for the models. Check if the factory has custom states that can be used before manually setting up the model. - Faker: Use methods such as `$this->faker->word()` or `fake()->randomDigit()`. Follow existing conventions whether to use `$this->faker` or `fake()`. - When creating tests, make use of `php artisan make:test [options] {name}` to create a feature test, and pass `--unit` to create a unit test. Most tests should be feature tests. ## Vite Error - If you receive an "Illuminate\Foundation\ViteException: Unable to locate file in Vite manifest" error, you can run `npm run build` or ask the user to run `npm run dev` or `composer run dev`. === octane/core rules === # Octane - Octane boots the application once and reuses it across requests, so singletons persist between requests. - The Laravel container's `scoped` method may be used as a safe alternative to `singleton`. - Never inject the container, request, or config repository into a singleton's constructor; use a resolver closure or `bind()` instead: ```php // Bad $this->app->singleton(Service::class, fn (Application $app) => new Service($app['request'])); // Good $this->app->singleton(Service::class, fn () => new Service(fn () => request())); ``` - Never append to static properties, as they accumulate in memory across requests. === livewire/core rules === # Livewire - Livewire allow to build dynamic, reactive interfaces in PHP without writing JavaScript. - You can use Alpine.js for client-side interactions instead of JavaScript frameworks. - Keep state server-side so the UI reflects it. Validate and authorize in actions as you would in HTTP requests. === pint/core rules === # Laravel Pint Code Formatter - If you have modified any PHP files, you must run `vendor/bin/pint --dirty --format agent` before finalizing changes to ensure your code matches the project's expected style. - Do not run `vendor/bin/pint --test --format agent`, simply run `vendor/bin/pint --format agent` to fix any formatting issues. === phpunit/core rules === # PHPUnit - This application uses PHPUnit for testing. All tests must be written as PHPUnit classes. Use `php artisan make:test --phpunit {name}` to create a new test. - If you see a test using "Pest", convert it to PHPUnit. - Every time a test has been updated, run that singular test. - When the tests relating to your feature are passing, ask the user if they would like to also run the entire test suite to make sure everything is still passing. - Tests should cover all happy paths, failure paths, and edge cases. - You must not remove any tests or test files from the tests directory without approval. These are not temporary or helper files; these are core to the application. ## Running Tests - Run the minimal number of tests, using an appropriate filter, before finalizing. - To run all tests: `php artisan test --compact`. - To run all tests in a file: `php artisan test --compact tests/Feature/ExampleTest.php`. - To filter on a particular test name: `php artisan test --compact --filter=testName` (recommended after making a change to a related file).