log1x/filament-starter

A beautiful starting point for your next TALL stack application.

dev-main 2024-07-20 12:17 UTC

Requires

• php: ^8.2
• awcodes/filament-curator: ^3.3
• awcodes/filament-gravatar: ^2.0
• bezhansalleh/filament-exceptions: ^2.0
• croustibat/filament-jobs-monitor: ^2.4.0
• diglactic/laravel-breadcrumbs: ^9.0
• filament/filament: ^3.2.50
• jeffgreco13/filament-breezy: ^2.2
• laravel/framework: ^11.0
• laravel/sanctum: ^4.0
• laravel/tinker: ^2.9
• livewire/livewire: ^3.3
• pboivin/filament-peek: ^2.2
• romanzipp/laravel-seo: ^2.6
• sinnbeck/markdom: ^2.0
• z3d0x/filament-logger: ^0.7.0

Requires (Dev)

• barryvdh/laravel-debugbar: ^3.9
• fakerphp/faker: ^1.9.1
• laravel/pint: ^1.0
• laravel/sail: ^1.18
• mockery/mockery: ^1.4.4
• nunomaduro/collision: ^8.1

MIT

• laravel
• livewire
• filament

README

Here lives a beautiful starting point to quickly bootstrap your next TALL stack application utilizing Filament for the admin panel.

Features

• 🚀 Quick, clean starting point with an example Post model and resource.
• 🧑‍💻 Fully pre-configured and customized Filament panel with best practices in place.
• 🎨 Clean, minimally styled frontend powered by Livewire.
• 💄 TailwindCSS and Vite ready for immediate use.
• 👷 Pre-bundled Livewire and Alpine for easy extendability.
• ⚡️ SPA-ready in both Filament and the frontend.
• 🔨 GitHub Actions workflows for Pint with pre-configured Dependabot for dependencies.
• 🔍️ Easy programmatic SEO using romanzipp/laravel-seo.

Requirements

Make sure all dependencies have been installed before moving on:

• PHP >= 8.2
• Composer
• Node.js >= 18
• Yarn

Getting Started

Start by creating the project using Composer and configuring the .env file:

composer create-project log1x/filament-starter:dev-main
cd filament-starter

After .env is configured, you can proceed to migrate & seed the database:

php artisan migrate:fresh --seed

Once the database is seeded, you can login at /admin using the default admin user:

Username: admin
Password: admin

Build Assets

The project assets are compiled using Vite. This can be done by installing the dependencies and running the build command with Yarn.

yarn install
yarn build

Plugins Used

The following Filament plugins come fully implemented and configured out of the box:

Bug Reports

If you discover a bug in Filament Starter, please open an issue.

Contributing

Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated.

License

Filament Starter is provided under the MIT License.