Download the PHP package kanekescom/filamentum without Composer

Filamentum

About Filamentum

Filamentum is a Laravel starter kit with the Filament admin panel and essential packages pre-installed.

Features

Application Menu

• [x] Dashboard
• [x] Users management
• [x] Roles management

Development Tools

• [x] Laravel Debugbar for debugging assistance
• [x] Laravel Telescope for monitoring and debugging

Deployment Tools

• [x] Laravel Sail for containerized development
• [x] Laravel Octane for high-performance serving

Installation

You can install Filamentum in two ways:

1. Via Laravel Installer (Recommended)

Create a new project using Laravel installer with Filamentum as the starter kit:

Note: For more information about Laravel Installer, please refer to the official Laravel Installer documentation.

2. Via Composer

You can install Filamentum in two ways:

a. Using Composer Create-Project:

b. Clone from GitHub:

After installation, your application will be ready with all the essential packages and configurations set up.

Configuration File

These settings are defined in config/filamentum.php.

Creating Users

To access the Filament admin panel, you'll need to create user accounts. The recommended approach is to use database seeding which creates predefined users with specific roles.

Database Seeding (Recommended)

Run the following command to create default users with predefined roles:

This command creates a complete user management system with:

1. Three predefined roles:

   • Super Admin (can access Dashboard, Users, and Roles)
   • Admin (can access Dashboard and Users)
   • User (can only access Dashboard)
2. Three corresponding users with the following credentials:

Once created, you can log in to the admin panel at /app using any of these credentials.

Interactive Command (Alternative)

If you prefer to create individual users interactively, you can use:

This command will prompt you to enter the user's name, email, and password. Note that users created this way will need to be manually assigned roles and permissions.

Filamentum Configuration

Filamentum provides several configuration options that allow you to customize the admin panel behavior. These settings can be configured through environment variables in your .env file.

Panel Path Configuration

You can change the URL path for the Filament admin panel:

The default path is app, which makes the admin panel accessible at /app. You can change this to any path you prefer, such as admin or dashboard.

Feature Toggles

Filamentum allows you to enable or disable various authentication features:

• FILAMENTUM_REGISTRATION: Enable or disable user registration (default: false)
• FILAMENTUM_PASSWORD_RESET: Enable or disable password reset functionality (default: false)
• FILAMENTUM_EMAIL_VERIFICATION: Enable or disable email verification (default: false)
• FILAMENTUM_EMAIL_CHANGE_VERIFICATION: Enable or disable email change verification (default: false)
• FILAMENTUM_PROFILE: Enable or disable user profile management (default: true)

Laravel Sail

This project comes with Laravel Sail pre-installed for Docker-based development environments. To get started with Sail, you'll need to have Docker installed on your system.

After installing Docker, you can start the Sail environment with:

Once the containers are up, you can access your application in your web browser at http://localhost.

For more information about Laravel Sail configuration and usage, please refer to the official Laravel Sail documentation.

Laravel Octane

This project comes with Laravel Octane pre-installed for high-performance serving of your Laravel application. To use Octane with FrankenPHP (the default server for this project), you need to run the installation command:

When prompted, select "frankenphp" as your server.

After installation, you can start your application using Octane with:

Note: For more information about Laravel Octane configuration and usage, please refer to the official Laravel Octane documentation.

Running Tests

PHPUnit Configuration

Before running tests, copy the PHPUnit configuration template:

The phpunit.xml file is gitignored, allowing you to add custom environment variables (such as API credentials) without committing them to the repository.

Running the Test Suite

You can run the test suite using Composer:

This will execute all tests using PestPHP, which is configured as the default testing framework for this project.

Alternatively, you can run tests directly using the Artisan command:

Installed Packages

Filamentum comes with several pre-installed packages to help you build your application:

• laravel/framework v12 - The core Laravel framework
• laravel/octane v2 - High-performance Laravel application server
• laravel/sail v1 - Docker setup for Laravel applications
• laravel/telescope v5 - Debug assistant for Laravel
• filament/filament v4 - Admin panel & app UI framework
• bezhansalleh/filament-shield v4 - Role & permission management
• spatie/laravel-permission v6 - Roles and permissions management
• barryvdh/laravel-debugbar v3 - Debug bar for Laravel

Recommended Additional Packages

To further enhance your Laravel application, consider adding these recommended packages:

• laravel/horizon - Dashboard for Laravel queues
• laravel/nightwatch - Application monitoring tool
• laravel/passport - OAuth2 server for API authentication
• laravel/sanctum - Authentication for SPAs and APIs
• laravel/socialite - OAuth authentication with social networks
• barryvdh/laravel-ide-helper v3 - IDE helper files for Laravel

Refer to each package's documentation for specific installation and configuration instructions.

License

Filamentum is open-sourced software licensed under the MIT license.