README

Easy FAQ Bundle

Provide a basic FAQ system for Easyadmin.

Features

A Easyadmin CRUD interface to manage FAQ elements

Versions

Repository Branch	Version	Symfony Compatibility	PHP Compatibility	Status
`3.x`	`3.x`	`6.4`, and `7.x`	`8.2` or higher	New features and bug fixes
`2.x`	`2.x`	`5.4`, and `6.x`	`8.0.2` or higher	Bug fixes
`1.x`	`1.x`	`4.4`, and `5.x`	`7.2.5` or higher	No longer maintained

Installation with Symfony Flex

Add our recipes endpoint

{
  "extra": {
    "symfony": {
      "endpoint": [
        "https://api.github.com/repos/agence-adeliom/symfony-recipes/contents/index.json?ref=flex/main",
        ...
        "flex://defaults"
      ],
      "allow-contrib": true
    }
  }
}

Install with composer

composer require agence-adeliom/easy-faq-bundle

Setup database

Using doctrine migrations

php bin/console doctrine:migration:diff
php bin/console doctrine:migration:migrate

Without

php bin/console doctrine:schema:update --force

Documentation

Manage in your Easyadmin dashboard

Go to your dashboard controller, example : src/Controller/Admin/DashboardController.php

<?php

namespace App\Controller\Admin;

...
use App\Entity\EasyFaq\Entry;
use App\Entity\EasyFaq\Category;

class DashboardController extends AbstractDashboardController
{
    ...
    public function configureMenuItems(): iterable
    {
        ...
        yield MenuItem::section('easy.faq.faq'); // (Optional)
        yield MenuItem::linkToCrud('easy.faq.admin.menu.entries', 'fa fa-file-alt', Entry::class);
        yield MenuItem::linkToCrud('easy.faq.admin.menu.categories', 'fa fa-folder', Category::class);

        ...

Customize faq's root path

#config/packages/easy_faq.yaml
easy_faq:
  ...
  page:
    root_path: '/blog'

NOTE : You will need to clear your cache after change because the RouteLoader need to be cleared.

License

MIT

agence-adeliom / easy-faq-bundle

Maintainers

Details