hydrat / grogu-cms
Quickly mount a Content Management System on top of Filament on Laravel. Chose your front stack, or go Headless.
Fund package maintenance!
Hydrat
Requires
- php: ^8.1
- bezhansalleh/filament-language-switch: ^3.0
- codeat3/blade-phosphor-icons: ^2.2
- codeat3/blade-radix-icons: ^1.7
- filament/filament: ^3.0
- filament/spatie-laravel-settings-plugin: ^3.1
- grantholle/laravel-altcha: ^1.1
- hydrat/filament-table-layout-toggle: >=1.1
- illuminate/contracts: >=10.0
- jeffgreco13/filament-breezy: ^2.2
- lorisleiva/laravel-actions: ^2.7
- nevadskiy/laravel-tree: ^0.5.0
- ralphjsmit/laravel-filament-media-library: ^3.8
- spatie/eloquent-sortable: ^4.2
- spatie/laravel-data: ^4.10
- spatie/laravel-package-tools: ^1.15.0
- spatie/laravel-permission: ^6.3
- tgeorgel/filament-tree: ^2.1
- vormkracht10/laravel-seo-scanner: ^3.10
Requires (Dev)
- nunomaduro/collision: ^7.9
- orchestra/testbench: ^8.0
- pestphp/pest: ^2.0
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- spatie/laravel-ray: ^1.26
This package is auto-updated.
Last update: 2024-11-21 17:10:27 UTC
README
This package aims to help you building a fast, reliable, and SEO-friendly website, by providing a set of tools to manage your content, settings, and SEO from your Filament panel.
It is designed to be used with a front-end stack of your choice, or as a headless CMS.
What this package provides :
- Users and Permissions management
- Multilingual dashboard
- Content management
- Pages
- Menus
- Forms
- Blueprints and Templates
- Flexible content blocks
- Hierarchical structure
- SEO tools
- Settings pages
This CMS is developer friendly : You are keeping the entire control on your models, migrations, routes, and views.
Screenshots
Installation
You can install the package via composer:
composer require hydrat/grogu-cms
You can publish and run the migrations with:
php artisan vendor:publish --tag="grogu-cms-migrations"
php artisan migrate
You can publish the config file with:
php artisan vendor:publish --tag="grogu-cms-config"
You can publish the assets with:
php artisan vendor:publish --tag="grogu-cms-assets"
Optionally, you can publish the views using
php artisan vendor:publish --tag="grogu-cms-views"
This is the contents of the published config file:
return [
];
You will need then to register the plugin into your Filament Panel :
GroguCMSPlugin::make() ->discoverTemplates(in: app_path('Content/Templates'), for: 'App\\Content\\Templates') ->discoverBlueprints(in: app_path('Content/Blueprints'), for: 'App\\Content\\Blueprints'), ->discoverBlockComposers(in: app_path('Content/BlockComposers'), for: 'App\\Content\\BlockComposers'),
To include Grogu scripts to your front-end, you should add the @groguScripts
directive to your layout, preferably before the closing </body>
tag :
@groguScripts
In addition, to setup dependancies, you will need to run the following commands:
php artisan seo:install
If using a Javascript front-end, such as Vue or React, you will also need to install puppeteer :
npm install puppeteer
Then, of your public models you will need to enable Javascript on SEO checks :
<?php namespace App\Models; use App\Cms\Models\Contracts\Resourceable; use App\Cms\Models\CmsModel; use Vormkracht10\Seo\Facades\Seo; use Vormkracht10\Seo\SeoScore; class Page extends CmsModel implements Resourceable { public function seoScore(): SeoScore { return Seo::check(url: $this->url, useJavascript: true); } }
Please make sur to set the required environment variables in your .env
file :
ALTCHA_HMAC_KEY={generated_random_key} ALTCHA_ALGORITHM="SHA-256" # SHA-256, SHA-384 or SHA-512
Please read the laravel-seo-scanner documentation for more details.
Usage
Defining your models
You can easily create a model using the make:cms-model
command :
php artisan make:cms-model Page
Basically, this model will be a regular Eloquent model, extending the CmsModel
class :
<?php namespace App\Models; class Page extends CmsModel { /** * @var string<BlueprintContract> */ protected static string $blueprintSchema = \App\Cms\Blueprints\PageBlueprint::class; }
The Blueprint is where the model configuration will happen. You can generate this file automatically by adding the --blueprint
option to the make:cms-model
command, or using the make:cms-blueprint
command :
php artisan make:cms-blueprint PageBlueprint
Blueprints helps GroguCMS by telling how to handle your model. It will :
- Define the front-end route to a single model (when applicable)
- Define the front-end view to use, when using our Controller helpers
- Enable/Disable features such as SEO, Exceprt, Content...
- Define templates and flexible layouts
- Define if the model is hierarchical
Rendering your models
Create the routes
First, you need to create the route to your pages. Here, we define the root path to use FrontPageController, as it will read the settings defined on the admin panel.
Route::get('/', Web\FrontPageShowController::class)->name('front-page.show'); Route::get('/{slug}', Web\PageShowController::class)->where('slug', '(.*)')->name('pages.show');
Using blade/livewire
Using inertia
When using Inertia, it is likely that you will want to filter the data sent to the browser. To do so, GroguCMS automatically convert your model to a JsonResource before sending it to the browser.
First, create a resource for your model :
php artisan make:resource PageResource
Then, add the Resourceable
contract to your model, and implement the toResource
method :
<?php namespace App\Models; use App\Cms\Contracts\Resourceable; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations; use Illuminate\Http\Resources\Json\JsonResource; class Page extends Model implements Resourceable { public function toResource(): JsonResource { return new \App\Http\Resources\PageResource($this); } }
You can then configure your resource as needed.
Contact form
The package provide a contact form resource that you can use to create forms on your website.
To get started, create a new form from Filament panel. You can then crete your own content block to display the form on your website.
// Using blade / livewire @livewire('grogu-cms::contact-form', ['form' => $form])
You can override models and resources by changing your configuration file :
/** * Define the models that Grogu CMS core should use. */ 'models' => [ 'form' => App\Models\Form::class, 'form_field' => App\Models\FormField::class, 'form_entry' => App\Models\FormEntry::class, ], /** * Define the resources that should be registred by the plugin. */ 'resources' => [ 'form_resource' => App\Filament\Resources\FormResource::class, ],
Overriding the livewire component is even easier, as you can just create a new component extending the original one :
<?php namespace App\Livewire; class MyContactForm extends Hydrat\GroguCMS\Livewire\ContactForm { public function submit() { parent::submit(); // Do something else } public function render() { return view('my-contact-form'); } } // @livewire('my-contact-form', ['form' => $form])
Deploy to production
Icons
As this package makes use of multiple blade icon packages (Radix, Phosphor...) it is highly recommended to cache your icons in your production environment. You should add this to your deployment script :
php artisan icons:clear
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.