README

A production-ready starter kit for building admin panels and internal tools with Laravel 13 and Filament 5. Includes a complete RBAC system, activity logging, and demo components to accelerate your development.

Why This Starter Kit?

• Skip the boilerplate - Authentication, authorization, and user management ready out of the box
• Learn Filament 5 - Demo cluster showcases forms, tables, widgets, actions, and infolists
• Production patterns - Policies, observers, services, and traits following Laravel best practices
• Modern stack - Latest versions of Laravel 13, Filament 5, Livewire 4, and Tailwind 4

Tech Stack

Features

Authentication & Authorization

• Filament Authentication - Login with session-based auth
• Role-Based Access Control - Granular permissions with hierarchical access levels
• Super Admin Role - Bypass all permission checks
• Policy-Based Authorization - Laravel policies for all resources

User Management

• User CRUD - Create, edit, delete users with role assignments
• User Status - Active/inactive status controls panel access
• Avatar Support - User profile images
• Blameable Records - Track who created/updated records

Activity Logging

• Audit Trail - Log all user actions automatically
• IP & User Agent - Capture request metadata
• Polymorphic Relations - Link logs to any model
• Login/Logout Tracking - Authentication events logged

Demo Showcase

• Form Inputs - All Filament input components
• Form Layouts - Sections, tabs, grids, wizards
• Tables - Columns, filters, actions, bulk actions
• Widgets - Stats, charts (line, bar, pie)
• Actions - Modal forms, confirmations, notifications
• Infolists - Read-only data display

Requirements

• PHP 8.4+
• Composer
• Node.js 20+ & pnpm
• SQLite (default) or MySQL/PostgreSQL

Installation

Using Laravel Installer (Recommended)

laravel new my-app --using=abitbt/filament

The installer will automatically set up everything for you.

Manual Installation

# Create project
composer create-project abitbt/filament my-app
cd my-app

# Or clone the repository
git clone https://github.com/abitbt/filament.git my-app
cd my-app
composer install

# Setup
pnpm install
cp .env.example .env
php artisan key:generate
php artisan migrate --seed
php artisan storage:link
pnpm run build

storage:link is required for user avatar uploads to render — they're stored under storage/avatars/ and served via the public symlink.

Start Development Server

composer run dev

Access the admin panel at: http://localhost:8000/admin

Default Credentials

Note: Change these credentials immediately in production environments.

Development Commands

# Development server with hot reload
composer run dev

# Code formatting
./vendor/bin/pint

# Static analysis
./vendor/bin/phpstan analyse

# Run all tests
unset APP_ENV && php artisan test

# Run specific test
unset APP_ENV && php artisan test --filter=UserResourceTest

Project Structure

app/
├── Enums/
│   ├── Permission.php         # Permission definitions with groups
│   ├── UserStatus.php         # Active/Inactive status
│   └── ActivityEvent.php      # Log event types
├── Filament/
│   ├── Clusters/Demo/         # Demo pages & widgets
│   ├── Pages/Dashboard.php    # Main dashboard
│   ├── Resources/
│   │   ├── UserResource/      # User management
│   │   ├── RoleResource/      # Role management
│   │   └── ActivityLogResource/
│   └── Widgets/               # Dashboard widgets
├── Models/
│   ├── Concerns/
│   │   ├── Blamable.php       # created_by/updated_by trait
│   │   └── HasPermissions.php # Permission checking trait
│   ├── User.php
│   ├── Role.php
│   ├── Permission.php
│   └── ActivityLog.php
├── Observers/                 # Model event observers
├── Policies/                  # Authorization policies
└── Services/
    ├── ActivityLogger.php     # Logging service
    └── PermissionRegistrar.php

Permission System

Permissions use a hierarchical access model:

Available Permissions

Activity logs are system-generated and immutable — no write permission is exposed.

Adding New Permissions

1. Add cases to app/Enums/Permission.php
2. Update getGroup() and getGroupIcon() methods
3. Create a policy in app/Policies/
4. Run php artisan db:seed --class=PermissionSeeder

Database Schema

users
├── id, name, email, password
├── avatar, status (enum)
├── role_id (foreign key)
├── created_by, updated_by (blameable)
└── timestamps

roles
├── id, name, slug, description
├── is_default (boolean)
└── timestamps

permissions
├── id, name, group, description
└── timestamps

role_permission (pivot)
├── role_id
└── permission_id

activity_logs
├── id, user_id
├── subject_type, subject_id (polymorphic)
├── event, description, properties (json)
├── ip_address, user_agent
└── created_at

Customization

Panel Configuration

Edit app/Providers/Filament/AdminPanelProvider.php:

return $panel
    ->brandName('Your App Name')
    ->colors(['primary' => Color::Blue])
    ->path('admin')  // Change URL path
    ->spa()          // SPA mode (remove for traditional)
    ->sidebarCollapsibleOnDesktop();

Adding Resources

# Generate a new resource
php artisan make:filament-resource Post --generate

# Generate with soft deletes
php artisan make:filament-resource Post --generate --soft-deletes

Adding Widgets

# Stats widget
php artisan make:filament-widget PostStats --stats-overview

# Chart widget
php artisan make:filament-widget PostsChart --chart

Testing

Tests use Pest 4 and cover all resources:

# Run all tests
unset APP_ENV && php artisan test

# Run with coverage
unset APP_ENV && php artisan test --coverage

# Run specific test file
unset APP_ENV && php artisan test tests/Feature/UserResourceTest.php

Contributing

1. Fork the repository
2. Create a feature branch
3. Run ./vendor/bin/pint and ./vendor/bin/phpstan analyse
4. Submit a pull request

License

This project is open-sourced software licensed under the MIT license.