384 lines
21 KiB
Markdown
384 lines
21 KiB
Markdown
# CLAUDE.md
|
||
|
||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||
|
||
## Project Overview
|
||
|
||
This is a multi-domain Laravel application ("Presseportale") that supports different domains with distinct themes and styling. The application uses Laravel with Livewire, Volt, and Fortify for authentication, along with Flux UI components.
|
||
|
||
### Supported Domains
|
||
|
||
- **Main Portal**: presseportale.test (local) / presseportale.com (live) – Main admin portal page
|
||
- **Presseecho**: presseecho.test - Landing page with presseecho theme
|
||
- **Business Portal**: businessportal24.test - Landing page with business portal theme
|
||
|
||
## Development Commands
|
||
|
||
### Installation & Setup
|
||
|
||
```bash
|
||
composer install
|
||
npm install
|
||
php artisan key:generate
|
||
php artisan migrate
|
||
php artisan migrate --seed # Run seeders for roles and permissions
|
||
```
|
||
|
||
### Asset Compilation
|
||
|
||
```bash
|
||
npm run dev:portal # Start Portal dev server (Port 5177)
|
||
npm run dev:web # Start Web dev server (Port 5178)
|
||
npm run dev:all # Start both dev servers concurrently (recommended)
|
||
npm run build # Production build (all)
|
||
npm run build:portal # Portal-specific assets
|
||
npm run build:web # Web-specific assets
|
||
```
|
||
|
||
### Development Server
|
||
|
||
```bash
|
||
php artisan serve # Start Laravel development server
|
||
composer run dev # Start full development stack (server, queue, logs, vite)
|
||
```
|
||
|
||
### Testing
|
||
|
||
```bash
|
||
composer run test # Run Pest tests (clears config first)
|
||
php artisan test # Direct Laravel test command
|
||
php artisan test --filter TestName # Run specific test
|
||
```
|
||
|
||
### Domain Management
|
||
|
||
```bash
|
||
php artisan domains:generate-favicons # Generate placeholder favicons for all domains
|
||
```
|
||
|
||
## Architecture
|
||
|
||
### Domain-Based Theme System
|
||
|
||
The application uses a sophisticated domain-based theme system that determines styling and assets at runtime:
|
||
|
||
**How it works:**
|
||
1. `ThemeServiceProvider` detects the incoming domain from the HTTP request
|
||
2. Looks up domain config in `/config/domains.php` by matching `domain_name`
|
||
3. Sets theme variables globally via `View::share()` and `config()`
|
||
4. Vite automatically loads the correct build directory based on `assets_dir`
|
||
|
||
**Key configuration** (`/config/domains.php`):
|
||
- Each domain has: `domain_name`, `url`, `theme`, `view_prefix`, `assets_dir`, `color_scheme`, `font`
|
||
- Portal domain uses `build/portal` assets
|
||
- Web domains (presseecho, businessportal24) share `build/web` assets but load different CSS theme files
|
||
|
||
**Development features:**
|
||
- Simulate any domain locally: Set `DEV_SIMULATE_DOMAIN=true` and `DEV_SIMULATED_DOMAIN=presseecho.test` in `.env`
|
||
- Theme override via URL: Add `?theme=presseecho` to test different themes
|
||
|
||
### Key Components
|
||
|
||
- **Livewire Components**: Located in `app/Livewire/` with the following structure:
|
||
- `app/Livewire/Actions/` - Reusable actions (e.g., Logout)
|
||
- Auth components in `resources/views/livewire/auth/` (login, register, password reset, etc.)
|
||
- Settings components in `resources/views/livewire/settings/` (profile, password, appearance)
|
||
- Admin components in `resources/views/livewire/admin/` (users management)
|
||
- Web components in `resources/views/livewire/web/` (frontend features)
|
||
- **Volt Components**: Single-file Livewire components using functional API for rapid development
|
||
- **Flux UI**: Premium UI component library for consistent design (Portal only)
|
||
- **Multi-Build System**: Separate Vite configurations for different asset bundles
|
||
|
||
### Authentication & Authorization
|
||
|
||
- **Laravel Fortify**: Handles authentication features
|
||
- **Laravel Sanctum**: API token authentication
|
||
- **Spatie Permissions**: Role and permission management system
|
||
|
||
### Asset Management
|
||
|
||
The project uses a **dual-port Vite setup** with separate configurations:
|
||
|
||
- **Portal (Backend)**: `vite.portal.config.js` - Port 5177, includes FluxUI
|
||
- **Web (Frontend)**: `vite.web.config.js` - Port 5178, no FluxUI
|
||
- **Tailwind Configs**: `tailwind.portal.config.js` and `tailwind.web.config.js`
|
||
|
||
**Why two ports?** Vite can only run one configuration at a time. The portal uses FluxUI components while web domains don't, requiring separate builds. Web domains (presseecho & businessportal24) share the same Vite server and differ only in CSS variables loaded at runtime via `ThemeServiceProvider`.
|
||
|
||
**Build directories**:
|
||
- Portal assets → `public/build/portal/`
|
||
- Web assets → `public/build/web/`
|
||
|
||
### Database
|
||
|
||
- **SQLite** for development (`database/database.sqlite`)
|
||
- **Migrations**: Users (with 2FA columns), cache, jobs, personal access tokens
|
||
- **Seeders**: `RolesAndPermissionsSeeder` - Run with `php artisan migrate --seed`
|
||
|
||
### Testing Framework
|
||
|
||
- **Pest PHP** (v3.8+) - Modern testing framework built on PHPUnit
|
||
- Configuration: `phpunit.xml` and `tests/Pest.php`
|
||
- Test database: Uses `DB_DATABASE=testing` environment (configured in phpunit.xml)
|
||
- Test directories: `tests/Feature/` (authentication, dashboard, settings) and `tests/Unit/`
|
||
|
||
## Important Files & Configuration
|
||
|
||
- **Domain System**:
|
||
- `/config/domains.php` - Domain and theme configuration
|
||
- `/app/Providers/ThemeServiceProvider.php` - Core theme switching logic at runtime
|
||
- `/routes/domains.php` - Domain-specific routing
|
||
|
||
- **Routes**:
|
||
- `/routes/web.php` - Public web routes
|
||
- `/routes/auth.php` - Authentication routes
|
||
- `/routes/admin.php` - Admin portal routes
|
||
- `/routes/api.php` - API endpoints with Sanctum protection
|
||
|
||
- **Views Structure**:
|
||
- `resources/views/web/` - Frontend domain views (presseecho, businessportal24)
|
||
- `resources/views/admin/` - Backend portal views
|
||
- `resources/views/components/` - Shared components across all domains
|
||
- `resources/views/components/layouts/` - Layout components (app, auth)
|
||
- `resources/views/livewire/` - Livewire components (auth, settings, admin, web)
|
||
|
||
- **Vite & Assets**:
|
||
- `vite.portal.config.js` - Backend/Portal build configuration (Port 5177)
|
||
- `vite.web.config.js` - Frontend/Web build configuration (Port 5178)
|
||
- `tailwind.portal.config.js` and `tailwind.web.config.js` - Separate Tailwind configs
|
||
- `resources/css/portal.css` - Portal styles with FluxUI
|
||
- `resources/css/web/theme-*.css` - Theme-specific CSS for web domains
|
||
|
||
- **Documentation**:
|
||
- `DOMAINS-CONFIG.md` - Detailed domain setup instructions
|
||
- `FORTIFY-SANCTUM-SETUP.md` - Authentication setup guide
|
||
- `VITE-SETUP.md` - Dual-port Vite architecture explanation
|
||
|
||
===
|
||
|
||
<laravel-boost-guidelines>
|
||
=== 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/fortify (FORTIFY) - v1
|
||
- laravel/framework (LARAVEL) - v12
|
||
- laravel/prompts (PROMPTS) - v0
|
||
- laravel/sanctum (SANCTUM) - v4
|
||
- livewire/flux (FLUXUI_FREE) - v2
|
||
- livewire/flux-pro (FLUXUI_PRO) - v2
|
||
- livewire/livewire (LIVEWIRE) - v4
|
||
- livewire/volt (VOLT) - v1
|
||
- larastan/larastan (LARASTAN) - v3
|
||
- laravel/boost (BOOST) - v2
|
||
- laravel/mcp (MCP) - v0
|
||
- laravel/pail (PAIL) - v1
|
||
- laravel/pint (PINT) - v1
|
||
- laravel/sail (SAIL) - v1
|
||
- pestphp/pest (PEST) - v3
|
||
- phpunit/phpunit (PHPUNIT) - v11
|
||
- alpinejs (ALPINEJS) - v3
|
||
- tailwindcss (TAILWINDCSS) - v4
|
||
|
||
## Skills Activation
|
||
|
||
This project has domain-specific skills available. You MUST activate the relevant skill whenever you work in that domain—don't wait until you're stuck.
|
||
|
||
- `fortify-development` — ACTIVATE when the user works on authentication in Laravel. This includes login, registration, password reset, email verification, two-factor authentication (2FA/TOTP/QR codes/recovery codes), profile updates, password confirmation, or any auth-related routes and controllers. Activate when the user mentions Fortify, auth, authentication, login, register, signup, forgot password, verify email, 2FA, or references app/Actions/Fortify/, CreateNewUser, UpdateUserProfileInformation, FortifyServiceProvider, config/fortify.php, or auth guards. Fortify is the frontend-agnostic authentication backend for Laravel that registers all auth routes and controllers. Also activate when building SPA or headless authentication, customizing login redirects, overriding response contracts like LoginResponse, or configuring login throttling. Do NOT activate for Laravel Passport (OAuth2 API tokens), Socialite (OAuth social login), or non-auth Laravel features.
|
||
- `laravel-best-practices` — Apply this skill whenever writing, reviewing, or refactoring Laravel PHP code. This includes creating or modifying controllers, models, migrations, form requests, policies, jobs, scheduled commands, service classes, and Eloquent queries. Triggers for N+1 and query performance issues, caching strategies, authorization and security patterns, validation, error handling, queue and job configuration, route definitions, and architectural decisions. Also use for Laravel code reviews and refactoring existing Laravel code to follow best practices. Covers any task involving Laravel backend PHP code patterns.
|
||
- `fluxui-development` — Use this skill for Flux UI development in Livewire applications only. Trigger when working with <flux:*> components, building or customizing Livewire component UIs, creating forms, modals, tables, or other interactive elements. Covers: flux: components (buttons, inputs, modals, forms, tables, date-pickers, kanban, badges, tooltips, etc.), component composition, Tailwind CSS styling, Heroicons/Lucide icon integration, validation patterns, responsive design, and theming. Do not use for non-Livewire frameworks or non-component styling.
|
||
- `volt-development` — Develops single-file Livewire components with Volt. Activates when creating Volt components, converting Livewire to Volt, working with @volt directive, functional or class-based Volt APIs; or when the user mentions Volt, single-file components, functional Livewire, or inline component logic in Blade files.
|
||
- `pest-testing` — Use this skill for Pest PHP testing in Laravel projects only. Trigger whenever any test is being written, edited, fixed, or refactored — including fixing tests that broke after a code change, adding assertions, converting PHPUnit to Pest, adding datasets, and TDD workflows. Always activate when the user asks how to write something in Pest, mentions test files or directories (tests/Feature, tests/Unit) or architecture tests. Covers: test()/it()/expect() syntax, datasets, mocking, browser testing, arch(), Livewire component tests, RefreshDatabase, and all Pest 3 features. Do not use for editing factories, seeders, migrations, controllers, models, or non-test PHP code.
|
||
- `tailwindcss-development` — Always invoke when the user's message includes 'tailwind' in any form. Also invoke for: building responsive grid layouts (multi-column card grids, product grids), flex/grid page structures (dashboards with sidebars, fixed topbars, mobile-toggle navs), styling UI components (cards, tables, navbars, pricing sections, forms, inputs, badges), adding dark mode variants, fixing spacing or typography, and Tailwind v3/v4 work. The core use case: writing or fixing Tailwind utility classes in HTML templates (Blade, JSX, Vue). Skip for backend PHP logic, database queries, API routes, JavaScript with no HTML/CSS component, CSS file audits, build tool configuration, and vanilla CSS.
|
||
|
||
## 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 `vendor/bin/sail npm run build`, `vendor/bin/sail npm run dev`, or `vendor/bin/sail 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., `vendor/bin/sail artisan route:list`). Use `vendor/bin/sail artisan list` to discover available commands and `vendor/bin/sail artisan [command] --help` to check parameters.
|
||
- Inspect routes with `vendor/bin/sail artisan route:list`. Filter with: `--method=GET`, `--name=users`, `--path=api`, `--except-vendor`, `--only-vendor`.
|
||
- Read configuration values using dot notation: `vendor/bin/sail artisan config:show app.name`, `vendor/bin/sail 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: `vendor/bin/sail artisan tinker --execute 'Your::code();'`
|
||
- Double quotes for PHP strings inside: `vendor/bin/sail 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.
|
||
|
||
=== sail rules ===
|
||
|
||
# Laravel Sail
|
||
|
||
- This project runs inside Laravel Sail's Docker containers. You MUST execute all commands through Sail.
|
||
- Start services using `vendor/bin/sail up -d` and stop them with `vendor/bin/sail stop`.
|
||
- Open the application in the browser by running `vendor/bin/sail open`.
|
||
- Always prefix PHP, Artisan, Composer, and Node commands with `vendor/bin/sail`. Examples:
|
||
- Run Artisan Commands: `vendor/bin/sail artisan migrate`
|
||
- Install Composer packages: `vendor/bin/sail composer install`
|
||
- Execute Node commands: `vendor/bin/sail npm run dev`
|
||
- Execute PHP scripts: `vendor/bin/sail php [script]`
|
||
- View all available Sail commands by running `vendor/bin/sail` without arguments.
|
||
|
||
=== tests rules ===
|
||
|
||
# Test Enforcement
|
||
|
||
- Every change must be programmatically tested. Write a new test or update an existing test, then run the affected tests to make sure they pass.
|
||
- Run the minimum number of tests needed to ensure code quality and speed. Use `vendor/bin/sail artisan test --compact` with a specific filename or filter.
|
||
|
||
=== laravel/core rules ===
|
||
|
||
# Do Things the Laravel Way
|
||
|
||
- Use `vendor/bin/sail artisan make:` commands to create new files (i.e. migrations, controllers, models, etc.). You can list available Artisan commands using `vendor/bin/sail artisan list` and check their parameters with `vendor/bin/sail artisan [command] --help`.
|
||
- If you're creating a generic PHP class, use `vendor/bin/sail 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 `vendor/bin/sail 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 `vendor/bin/sail 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 `vendor/bin/sail npm run build` or ask the user to run `vendor/bin/sail npm run dev` or `vendor/bin/sail composer run dev`.
|
||
|
||
=== laravel/v12 rules ===
|
||
|
||
# Laravel 12
|
||
|
||
- CRITICAL: ALWAYS use `search-docs` tool for version-specific Laravel documentation and updated code examples.
|
||
- Since Laravel 11, Laravel has a new streamlined file structure which this project uses.
|
||
|
||
## Laravel 12 Structure
|
||
|
||
- In Laravel 12, middleware are no longer registered in `app/Http/Kernel.php`.
|
||
- Middleware are configured declaratively in `bootstrap/app.php` using `Application::configure()->withMiddleware()`.
|
||
- `bootstrap/app.php` is the file to register middleware, exceptions, and routing files.
|
||
- `bootstrap/providers.php` contains application specific service providers.
|
||
- The `app/Console/Kernel.php` file no longer exists; use `bootstrap/app.php` or `routes/console.php` for console configuration.
|
||
- Console commands in `app/Console/Commands/` are automatically available and do not require manual registration.
|
||
|
||
## Database
|
||
|
||
- When modifying a column, the migration must include all of the attributes that were previously defined on the column. Otherwise, they will be dropped and lost.
|
||
- Laravel 12 allows limiting eagerly loaded records natively, without external packages: `$query->latest()->limit(10);`.
|
||
|
||
### Models
|
||
|
||
- Casts can and likely should be set in a `casts()` method on a model rather than the `$casts` property. Follow existing conventions from other models.
|
||
|
||
=== volt/core rules ===
|
||
|
||
# Livewire Volt
|
||
|
||
- Single-file Livewire components: PHP logic and Blade templates in one file.
|
||
- Always check existing Volt components to determine functional vs class-based style.
|
||
- IMPORTANT: Always use `search-docs` tool for version-specific Volt documentation and updated code examples.
|
||
- IMPORTANT: Activate `volt-development` every time you're working with a Volt or single-file component-related task.
|
||
|
||
=== pint/core rules ===
|
||
|
||
# Laravel Pint Code Formatter
|
||
|
||
- If you have modified any PHP files, you must run `vendor/bin/sail bin pint --dirty --format agent` before finalizing changes to ensure your code matches the project's expected style.
|
||
- Do not run `vendor/bin/sail bin pint --test --format agent`, simply run `vendor/bin/sail bin pint --format agent` to fix any formatting issues.
|
||
|
||
=== pest/core rules ===
|
||
|
||
## Pest
|
||
|
||
- This project uses Pest for testing. Create tests: `vendor/bin/sail artisan make:test --pest {name}`.
|
||
- Run tests: `vendor/bin/sail artisan test --compact` or filter: `vendor/bin/sail artisan test --compact --filter=testName`.
|
||
- Do NOT delete tests without approval.
|
||
|
||
</laravel-boost-guidelines>
|