Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 3.9 KB

README.md

File metadata and controls

82 lines (56 loc) · 3.9 KB
Raw

Filament Starter

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

Screenshot

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:

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:

Plugin Description Author
Curator A beautiful media library. awcodes
Gravatar Easy avatar integration powered by Gravatar. awcodes
Exceptions A simple but powerful Exception viewer. bezhansalleh
Jobs Monitor Easily monitor background jobs and their progress. croustibat
Breezy Customizable user profile pages and 2FA support. jeffgreco13
Peek Quick & efficient front-end previews of resources. pboivin
Logger Zero-config resource activity logging. z3d0x

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.