From 47c63596637fc7c0c5c0512696c3dcd15044cc7b Mon Sep 17 00:00:00 2001 From: idevakk <219866223+idevakk@users.noreply.github.com> Date: Mon, 29 Sep 2025 14:58:12 +0530 Subject: [PATCH] chore(docs): update README.md --- README.md | 48 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 39 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1655b5c..3147147 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Ideal for developers who want to skip boilerplate setup and jump straight into b * ✅ Roles & Permissions (Spatie) * ✅ Activity Logging * ✅ Mail & Log Viewer +* ✅ **Database Config Manager (via Filament Plugin)** * ✅ Code quality with **RectorPHP** * ✅ Authentication with default seeded admin @@ -75,9 +76,9 @@ return [ 'warning' => Color::Amber, ], - 'enable_login' => env('FILAMENT_ENABLE_LOGIN', true), - 'enable_registration'=> env('FILAMENT_ENABLE_REGISTER', false), - 'enable_profile' => env('FILAMENT_ENABLE_PROFILE', false), + 'enable_login' => env('FILAMENT_ENABLE_LOGIN', true), + 'enable_registration' => env('FILAMENT_ENABLE_REGISTER', false), + 'enable_profile' => env('FILAMENT_ENABLE_PROFILE', false), ]; ``` @@ -124,6 +125,33 @@ class RoleSeeder extends Seeder --- +## 🛠️ Manage Config from Admin Panel (Inerba DB Config Plugin) + +This starter kit includes the [**Filament DB Config Plugin**](https://filamentphp.com/plugins/inerba-db-config) by **Inerba**, which allows you to **store application config settings in the database** and manage them from the admin panel. + +### 🔧 Features + +* Create configuration keys and values dynamically +* Group and categorize settings +* Easily retrieve values via `config('db-config.key')` +* No code deployment needed for config changes + +### 🧩 Usage + +After installing and publishing the plugin: + +1. Visit `/dash/db-config` in your Filament panel +2. Add new config entries (e.g. `site.name`, `maintenance_mode`, etc.) +3. Use in code like so: + +```php +$value = config('db-config.site.name'); +``` + +> ℹ️ Useful for managing site-wide settings, feature toggles, or any admin-editable config. + +--- + ## 📨 Mail Viewer View all outgoing mail inside the Filament admin panel — ideal for local and staging environments. @@ -172,7 +200,7 @@ vendor/bin/rector ## 🚀 Installation ```bash -git clone https://github.com/your-org/admin-starter-kit.git your-project +git clone https://github.com/idevakk/starter-kit.git your-project cd your-project composer install @@ -196,20 +224,21 @@ Visit: [http://localhost:8000/dash](http://localhost:8000/dash) (or your configu ``` ├── config/ -│ ├── filament.php # Filament core settings -│ ├── filament-php.php # UI theming + custom toggles -│ ├── activitylog.php # Activity log config +│ ├── filament.php # Filament core settings +│ ├── filament-php.php # UI theming + custom toggles +│ ├── activitylog.php # Activity log config +│ └── db-config.php # (Optional) Plugin config ├── database/ │ └── seeders/FilamentAdminSeeder.php │ └── seeders/RoleSeeder.php -├── rector.php # Rector config +├── rector.php # Rector config ``` --- ## 🤝 Contributing -Contributions are welcome. Feel free to fork, submit issues or create pull requests. +Contributions are welcome. Feel free to fork, submit issues, or create pull requests. --- @@ -228,6 +257,7 @@ Open-sourced under the [MIT license](LICENSE). * [Spatie Activity Log](https://spatie.be/docs/laravel-activitylog) * [Filament Log Viewer](https://github.com/ryangjchandler/filament-log) * [Filament Mail Viewer](https://github.com/ryangjchandler/filament-mail) +* [Inerba DB Config Plugin](https://filamentphp.com/plugins/inerba-db-config) * [RectorPHP](https://getrector.com) ---