From 51cbe6fa5045f487c6e8e39e2df543e659bf1273 Mon Sep 17 00:00:00 2001 From: Dan Harrin Date: Sun, 20 Jul 2025 13:01:56 +0100 Subject: [PATCH] Update 03-optimizing-local-development.md --- ....md => 03-optimizing-local-development.md} | 69 +++++++++++-------- 1 file changed, 42 insertions(+), 27 deletions(-) rename docs/01-introduction/{03-optimizing-local-dev.md => 03-optimizing-local-development.md} (70%) diff --git a/docs/01-introduction/03-optimizing-local-dev.md b/docs/01-introduction/03-optimizing-local-development.md similarity index 70% rename from docs/01-introduction/03-optimizing-local-dev.md rename to docs/01-introduction/03-optimizing-local-development.md index 46610f604c..9043b6da7d 100644 --- a/docs/01-introduction/03-optimizing-local-dev.md +++ b/docs/01-introduction/03-optimizing-local-development.md @@ -1,9 +1,9 @@ --- -title: Optimizing local dev +title: Optimizing local development --- import Aside from "@components/Aside.astro" -This section includes optional tips to improve performance and developer experience when running your Laravel app locally. +This section includes optional tips to optimize performance when running your Filament app locally. If you're looking for production-specific optimizations, check out [Deploying to production](../deployment). @@ -23,7 +23,7 @@ You should see `opcache.enable => 1`. If not, enable it by adding the following opcache.enable=1 # Enable OPcache ``` -### Optional OPcache settings +### Configuring OPcache settings If you're experiencing slow response times or suspect that OPcache is running out of space, you can adjust these parameters in your `php.ini` file: @@ -37,32 +37,37 @@ opcache.max_accelerated_files=10000 These settings are optional but useful if you're troubleshooting performance or working on a large Laravel app. -## Disabling view debugging in Laravel Herd +## Exclude your project folder from antivirus scanning -[Laravel Herd](https://herd.laravel.com/) includes a view debugging tool for [macOS](https://herd.laravel.com/docs/macos/debugging/dumps#views) and [Windows](https://herd.laravel.com/docs/windows/debugging/dumps#views). -It shows which views were rendered and what data was passed to them during a request. +Issues with the performance of Filament, particularly on Windows, often involve [Microsoft Defender](https://www.microsoft.com/en-us/microsoft-365/microsoft-defender-for-individuals). + +Security software, such as realtime file scanners or antivirus tools, can slow down your development environment by scanning files every time they're accessed. This can affect PHP execution, view rendering, and performance in general. + +If you're noticing slowness, consider excluding your local project folder from realtime scanning. + +Tools like [Microsoft Defender](https://www.microsoft.com/en-us/microsoft-365/microsoft-defender-for-individuals), or similar antivirus solutions, can be configured to skip specific directories. Check your antivirus or security software documentation for instructions on how to exclude specific folders from realtime scanning. + + + +## Disabling debugging tools + +Debugging tools can be very useful for local development, but at the same time slow down your application unnecessarily when you aren't using them. + +### Disabling view debugging in Laravel Herd + +[Laravel Herd](https://herd.laravel.com/) includes a view debugging tool for [macOS](https://herd.laravel.com/docs/macos/debugging/dumps#views) and [Windows](https://herd.laravel.com/docs/windows/debugging/dumps#views). It shows which views were rendered and what data was passed to them during a request. While helpful for debugging, this feature can significantly slow down your app. If you're not actively using it, it's best to turn it off. To disable view debugging in Herd: + - Open Herd > Dumps. - Click Settings. - Uncheck the "Views" option. -## Disabling Xdebug -[Xdebug](https://xdebug.org/) is a powerful tool for debugging, but it can slow down performance. If you notice performance issues, check if `Xdebug` is installed and consider disabling it. - -## Caching Blade icons - -Caching [Blade icons](https://blade-ui-kit.com/blade-icons) can help improve performance during local development, especially on views that include many icons. - -To enable caching, run: - -```bash -php artisan icons:cache -``` - -## Disabling Debugbar +### Disabling Debugbar While useful for debugging, [Laravel Debugbar](https://github.com/barryvdh/laravel-debugbar) can slow down your application, especially on complex pages, because it collects and renders a large amount of data on each request. @@ -75,14 +80,24 @@ DEBUGBAR_ENABLED=false If you still need Debugbar for development, consider disabling specific collectors you're not using. Refer to the [Debugbar documentation](https://github.com/barryvdh/laravel-debugbar?tab=readme-ov-file#debugbar-for-laravel) for details. -## Exclude your project folder from antivirus scanning +### Disabling Xdebug -Security software, such as realtime file scanners or antivirus tools, can slow down your development environment by scanning files every time they're accessed. This can affect PHP execution, view rendering, and performance in general. +[Xdebug](https://xdebug.org) is a powerful tool for debugging, but it can significantly slow down performance. If you notice performance issues, check if `Xdebug` is installed and consider disabling it. -If you're noticing slowness, consider excluding your local project folder from realtime scanning. +If `Xdebug` is installed but not disabled, it will still be enabled by default. If you have it installed, make sure it is explicitly disabled in your `php.ini` file: -Tools like [Microsoft Defender](https://www.microsoft.com/en-us/microsoft-365/microsoft-defender-for-individuals), or similar antivirus solutions, can be configured to skip specific directories. Check your antivirus or security software documentation for instructions on how to exclude specific folders from realtime scanning. +```ini +xdebug.mode=off # Disable Xdebug +``` - +## Caching Blade icons + +Caching [Blade icons](https://blade-ui-kit.com/blade-icons) can help improve performance during local development, especially in views that render many icons. + +To enable caching, run: + +```bash +php artisan icons:cache +``` + +Make sure that when you install new Blade icon packages, you run the command again to discover the new icons.