You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://packagist.org/packages/codewithdennis/larament)
8
8
9
-
Larament is a **bloat-free starter kit** for quickly launching **Laravel 12.x** projects. It comes with **FilamentPHP 4.x** pre-installed and configured, plus essential tools to speed up your development—nothing more, nothing unnecessary.
9
+
A **bloat-free starter kit** for Laravel 12.xwith FilamentPHP 4.x pre-configured. Only essential development tools included.
10
10
11
11
> [!CAUTION]
12
12
> **Filament 4** is currently in beta — use it cautiously in production.
13
13
14
14
> [!NOTE]
15
-
> Larament requires **PHP 8.3** or higher to run.
15
+
> Requires **PHP 8.3** or higher.
16
16
17
-
## Dependencies
17
+
## What's Included
18
18
19
-
This project includes several core dependencies that provide essential functionality:
19
+
### Core Dependencies
20
+
-**Laravel 12.x** - The PHP framework
21
+
-**FilamentPHP 4.x** - Admin panel with SPA mode, custom theme, and MFA enabled
-**[nunomaduro/essentials](https://github.com/nunomaduro/essentials)**: Essentials provide better defaults for your Laravel applications including strict models, automatically eagerly loaded relationships, immutable dates, and more!
24
+
### Development Tools
25
+
-**larastan/larastan** - Static analysis
26
+
-**laravel/pint** - Code style fixer
27
+
-**pestphp/pest** - Testing framework
28
+
-**rector/rector** - Automated refactoring
29
+
-**barryvdh/laravel-debugbar** - Development insights
22
30
23
-
## Development
24
-
25
-
This project includes several development dependencies to ensure code quality and streamline the development process:
26
-
27
-
-**[larastan/larastan](https://github.com/larastan/larastan)**: Static analysis tool for Laravel applications
28
-
-**[laravel/pint](https://laravel.com/docs/12.x/pint)**: PHP code style fixer for Laravel projects
-**[barryvdh/laravel-debugbar](https://github.com/barryvdh/laravel-debugbar)**: A package that providing insights into queries, requests, and performance metrics during development.
35
-
36
-
These tools help maintain code quality, provide testing capabilities, and improve the development experience. Larament comes with a bunch of tests to ensure everything works as expected.
31
+
### Testing
32
+
Includes a comprehensive test suite with Pest - perfect for learning testing or as a reference for your own tests.
37
33
38
34

39
35
40
-
## Configurations
36
+
## Quick Start
41
37
42
-
Larament comes with several pre-configured settings to enhance your development experience:
- SPA Mode enabled by default for a smoother, more responsive admin experience
46
-
-`Color::Blue` color as the primary color
47
-
- Custom login page with autofilled credentials in local environment for easier development
48
-
- Includes a pre-configured custom theme, allowing for easy styling customization and consistent design across your admin panel
49
-
- Profile enabled by default, allowing users to manage their profiles directly from the admin panel
50
-
- (MFA) is enabled by default (App Authentication), providing an extra layer of security for your admin panel
50
+
- SPA mode enabled
51
+
- Custom login page with autofilled credentials in local environment
52
+
- Custom theme included
53
+
- Profile management enabled
54
+
- MFA (App Authentication) enabled
51
55
52
56

53
-
54
-
### Filament Table Configuration
55
-
All Filament tables are pre-configured with:
56
-
-**Striped Rows**: For better visual separation between rows
57
-
-**Deferred Loading**: Improves performance by loading table data after the initial page load
58
-
59
-

60
57
61
-
### Laravel Migration Stubs
62
-
Larament includes custom migration stubs that removes the `down()` method by default. The removal of the `down()` method is a debated topic in the Laravel community - while some developers prefer to keep it for rollback capabilities, others find it rarely used in practice. If you prefer to keep the `down()` method, you can simply remove these custom stubs and Laravel will use its default migration templates.
58
+
### Filament Tables
59
+
- Striped rows for better visual separation
60
+
- Deferred loading for improved performance
63
61
64
-
```php
65
-
<?php
62
+

66
63
67
-
declare(strict_types=1);
64
+
### Development Workflow
65
+
```bash
66
+
composer review # Runs Pint, Rector, PHPStan, and Pest
67
+
```
68
68
69
-
use Illuminate\Database\Migrations\Migration;
70
-
use Illuminate\Database\Schema\Blueprint;
71
-
use Illuminate\Support\Facades\Schema;
69
+
## Customizations
72
70
73
-
return new class() extends Migration
74
-
{
75
-
public function up(): void
76
-
{
77
-
//
78
-
}
79
-
};
80
-
```
71
+
### Migration Stubs
72
+
Custom stubs remove the `down()` method by default. Remove the custom stubs to use Laravel's default templates.
81
73
82
74
### Helper Functions
83
-
Larament comes with a pre-configured`app/Helpers.php` file where you can define your own helper functions. The file is already set up in your `composer.json` for autoloading. Here's an example of how to add your own helper functions:
75
+
Add your own helpers in`app/Helpers.php`:
84
76
85
77
```php
86
78
if (! function_exists('example')) {
87
79
function example(): string
88
80
{
89
-
return 'This is an example function you can use in your project.';
81
+
return 'Your helper function here.';
90
82
}
91
83
}
92
84
```
93
85
94
-
## Development Commands
95
-
96
-
Larament includes a convenient composer command to streamline your development workflow:
97
-
98
-
```bash
99
-
composer review
100
-
```
101
-
102
-
This command runs all code quality tools in sequence:
103
-
- Laravel Pint for code style fixing
104
-
- Rector for automated code refactoring
105
-
- PHPStan for static analysis
106
-
- Pest for testing
107
-
108
-
## Installation
109
-
110
-
Create a new Larament project and set it up with a single command:
0 commit comments