Filament Laravel Package

Getting Started

The package is small and thinly documented, so treat the repository itself as the primary reference.

1. Confirm the Filament version first. nop-app/filament was last released in mid‑2022, which places it in the Filament v2 era. Check composer.json in the repo for the exact filament/filament constraint before installing anything, and pin your app accordingly.
2. Install alongside the Nop core. This is an integration package, not a standalone admin panel. You need the underlying Nop application packages installed and configured first, since the Filament resources here operate on Nop models and services.

   composer require nop-app/filament
   

3. Register the service provider. If auto-discovery doesn't pick it up (common with older packages), add the provider to config/app.php or bootstrap/providers.php depending on your Laravel version.
4. Publish anything publishable.

   php artisan vendor:publish --provider="Nop\Filament\FilamentServiceProvider"
   

   Inspect config/ in the repo to see what tags and config keys are actually available — don't assume.
5. Where to look first. Open src/ and read the service provider, then any Resources/, Pages/, and Widgets/ directories. That file tree is the documentation.
6. First use case. The realistic day‑one goal is exposing Nop content entities (pages, posts, settings, media) as Filament resources inside a panel, so editors can manage Nop data through the Filament UI instead of the Nop front end. Register the package's resources on your panel and verify one entity (e.g. pages) loads before wiring up the rest.

Implementation Patterns

Resource-driven CRUD. The core pattern is Filament Resource classes mapped to Nop Eloquent models. Day to day you'll:

• Add or override a resource to change form/table columns.
• Extend the package's resource classes rather than editing vendor code, so updates don't clobber your changes (though see Gotchas — updates are unlikely).
• Register extended resources on your panel in PanelProvider::panel()->resources([...]).

Panel registration. If the package ships a panel provider, either use it as-is or copy its configuration into your own provider so you control navigation groups, colors, and middleware. This is the safest way to integrate with an existing Filament panel.

Navigation and grouping. Nop entities typically belong in a dedicated navigation group (e.g. "Content", "Catalog"). Set protected static ?string $navigationGroup and $navigationSort in your subclassed resources to keep the admin tidy.

Authorization. Map Nop's permission/role concepts onto Filament policies. If Nop has its own ACL, write a policy that delegates to it rather than duplicating rules in Filament — otherwise the two systems drift.

Widgets and dashboards. Add stats widgets (counts of Nop entities, recent activity) via ->widgets([...]) on the panel. Keep widgets read-only; avoid heavy queries in dashboard widgets on large Nop datasets.

Settings pages. Nop settings fit naturally as Filament custom pages backed by a settings form. Use a custom Page with a form schema that reads/writes through Nop's settings service rather than a model if settings aren't a normal table.

Media/file handling. If Nop stores media through its own storage layer, override the Filament FileUpload disk and directory config to point at Nop's paths so uploads land where the front end expects them.

Multi-panel setups. If you have separate admin and editor panels, register only the relevant Nop resources per panel to reduce clutter.

Gotchas and Tips

• Version compatibility is the big risk. A 2022 package will not work with Filament v3 out of the box (namespace, form/table API, and panel registration all changed). If your app is on Filament v3+, expect to fork and port the resources rather than install cleanly.
• Tiny package, no safety net. 13 stars and a single 2022 release means effectively no community support and no upstream maintenance. Budget for owning the code: fork it, pin the commit, and vendor it if necessary.
• Read composer.json before composer require. Look at its require block for laravel/framework, filament/*, and Nop core constraints. Mismatched constraints are the most likely install failure, and you'll want --with-all-dependencies or explicit version pins.
• Auto-discovery may not fire. Older packages sometimes use a provider class not listed in extra.laravel.providers, or a different namespace than expected. If resources don't appear, check php artisan about (providers section) to confirm the provider loaded.
• Debugging missing resources. If a resource exists but doesn't show in navigation:
  • Verify it's registered on the correct panel.
  • Check canViewAny() / policy authorization — hidden resources are usually a permission issue, not a registration issue.
  • Run php artisan filament:optimize-clear after config or resource changes.
• Don't edit vendor files. Even though updates are rare, keep changes in subclasses or overrides inside your app/Filament tree so a future patch doesn't erase your work — and so the change is reviewable.
• Config quirks. Inspect the published config for keys that reference Nop class names or table names. Those are the usual breakpoints when Nop version drifts — a renamed model or table will silently break resources at runtime.
• Extension points to prefer. Service provider and resource subclassing are the stable extension surface. Avoid overriding Blade views from the package unless you must; views change and are hard to track.
• Test the upgrade path early. If the package works on your current stack, lock its version exactly ("nop-app/filament": "x.y.z") and add a smoke test that loads each resource index page, so future Laravel/Filament bumps fail loudly instead of silently.
• Consider the alternative. Given the maintenance state, evaluate whether writing your own thin set of Filament resources over Nop models is cleaner than adopting this package. For a handful of entities it's often less work than porting a stale dependency.