networkrailbusinesssystems / support-page
Allows you quickly add a support page to your project
Requires
- php: ^8.3
- anthonyedmonds/govuk-laravel: ^5
- illuminate/support: ^11
- laracasts/flash: ^3
- spatie/laravel-permission: ^6
Requires (Dev)
README
Use the Support Page Library to add the following to your GOV.UK Laravel library Project:
- Admin access to create, edit and delete Support Details.
- A Support Page to display Support Details.
What's in the box?
- Laravel 11 Blade Support Page Admin Access in the GOV.UK Design
- Laravel 11 Blade Support Page in the GOV.UK Design
- PHP 8.3
Installation
Via Composer: composer require networkrailbusinesssystems/support-page
Publish files
All essential files are published via the command php artisan vendor:publish --provider="NetworkRailBusinessSystems\SupportPage\Providers\SupportPageProvider" --tag="support-page"
.
This command includes the support-page tag files:
support-page
This command will publish the config and database migration:
- /config/support-page.php
- /database/migrations/2023_02_07_105304_create_support_details_table.php
support-page-views
This command will publish the Blade views:
- /resources/views/details
- /resources/views/show.blade.php
Set-up
Pre-requisites
The Support Page library requires the GOVUK Laravel Forms Route Macro.
Routing
A route macro is provided to handle the Support Page, and it's Admin functions. Add the following to your routes/web.php
file:
Route::supportPage();
- Add the permission
'manage_support_page'
with admin rights. - Add a 'Manage Support Details' link to the admin blade with the route
support-page.admin.index
and wrap the section with@can
:
@can('manage_support_page') <li> <x-govuk::a href="{{ route('support-page.admin.index') }}"> Manage Support Details </x-govuk::a> </li> @endcan
- Register the form
SupportDetailForm::class
in the GOVUK Config. - Update permissions and run database migrations.
Configuration
There are three configurable values in the Support-page config: