README

Kickstart your project and save time with Larament! This time-saving starter kit includes a Laravel project with FilamentPHP already installed and set up, along with extra features.

Note

This starter kit includes Laravel 11 and FilamentPHP 3 with some packages that improve the development experience. This will not contain any bloated features or unnecessary packages. If you want to add more features, you can do so by installing the necessary packages.

Configuration

Security and Testing

A handfull of PESTPHP test cases are included for testing.
Should be strict
- Prevents lazy loading (N+1) queries.
- It prevents silently discarding attributes.
- It prevents accessing missing attributes.
Prevent destructive commands from running in production
Archtest is included for architectural testing.
PHPStan is included for static analysis.
Laravel debugbar is included for debugging.

Quality of Life

A custom login page autofills email and password with seeded data, streamlining local testing.
A custom password generator action is available on the user profile and user resource pages.
Global user search includes email addresses in results for better user discovery.
All component labels are automatically translatable.
A composer review command that runs PINT, PHPStan, and PEST.
Helper file is included for custom helper functions.
A custom php artisan make:filament-action command is available for creating actions.

Design

The Filament Panel's primary color is set to blue.
Single Page Application (SPA) mode is enabled by default.
Global search keybinding is preset to CTRL + K or CMD + K.
A ready-to-use FilamentPHP custom theme that also includes a sidebar separator.
A custom profile that includes the password generator action.

Default User

The default user is seeded with the following credentials which is autofilled on the login page.

DEFAULT_USER_EMAIL="admin@example.com"
DEFAULT_USER_PASSWORD="password"

Packages

Installation

Use this template to create a new repository and clone it to your local machine, then navigate to the project directory to run the necessary commands.

composer install
npm install && npm run build
cp .env.example .env
php artisan key:generate

CLI Installation

You can also use the following command to create a new project with Larament.

composer create-project --prefer-dist CodeWithDennis/larament example-app

If you don't want to remember the composer installation syntax for future projects, you can create an alias for your terminal:

alias larament="composer create-project --prefer-dist CodeWithDennis/larament"

This allows you to simply use larament my-cool-app in your terminal.

larament my-cool-app

codewithdennis / larament

Maintainers

Details