creode / laravel-nova-faqs
FAQs package for Laravel Nova
Requires
- php: ^7.3|^8.0
- creode/laravel-repository: ^1.0
- creode/nova-publishable: ^1.1
- laravel/nova: ^4.0
- manogi/nova-tiptap: ^3.2
- outl1ne/nova-sortable: ^3.4
- spatie/laravel-package-tools: ^1.14.0
Requires (Dev)
README
Exposes some simple FAQ functionality within Laravel Nova.
Installation
Installation for this package is simple, just require the package via composer:
composer require creode/laravel-nova-faqs
Usage
Migrations
Once installed, you will need to run the migrations to create the required database tables:
php artisan migrate
Configuration
You will also need to publish the config file to set up the required settings:
php artisan vendor:publish --tag="nova-faqs-config"
This will create a config/nova-faqs.php
file which you can use to configure the package.
Customising the FAQ Model
The default Event model can be replaced to allow you to add new features to it within your main application. This can easily be done by changing the model in the config/nova-faqs.php
file:
// config/nova-faqs.php return [ ... 'faqs_model' => App\FaqModel::class, ... ];
Querying FAQs
You can make queries on blogs by using the Repository class:
use Creode\LaravelNovaFaqs\Repositories\FaqRepository; $faqRepository = new FaqRepository(); $faqs = $faqRepository->all();
Seeding FAQs
You can seed FAQs using the EventFactory:
php artisan db:seed --class="Creode\LaravelNovaFaqs\Database\Seeders\FAQsDatabaseSeeder"
## Dependencies This package depends on the following packages:
- TipTap - For rendering WYSIWYG content.
- Laravel Repository - For allowing a repository pattern to be used for querying the database.
- Nova Sortable - For allowing items to be sorted.
- Nova Publishable - For allowing items to be published or unpublished.
- Laravel Nova - For the admin interface.