README

Sylius Happy CMS Plugin

Overview • Installation • Documentation

Overview

Happy CMS is a Content Management System (CMS) plugin for Sylius that enables you to create and manage dynamic, routable Sylius resources content with ease. It provides a flexible framework for building pages, managing blocks of content, and defining custom routable entities, all integrated seamlessly into your Sylius e-commerce platform.

A duo: Happy CMS + Easy CRUD

This plugin is built to work hand in hand with Sylius Easy CRUD Plugin to provide a seamless experience for managing CMS routable resources in front, and CRUD admin interfaces easily within Sylius.

Installation

1. Install via Composer

composer require agence-adeliom/sylius-happy-cms-plugin --no-scripts
composer require --dev symfony/maker-bundle

2. Enable the Bundle

Add the plugin to config/bundles.php:

<?php

return [
    // ...
    Adeliom\SyliusEasyCrudPlugin\SyliusEasyCrudPlugin::class => ['all' => true],
    Adeliom\SyliusHappyCMSPlugin\SyliusHappyCMSPlugin::class => ['all' => true],
   
    Symfony\Bundle\MakerBundle\MakerBundle::class => ['dev' => true, 'test' => true],
];

3. Import Configuration

In config/packages/_sylius.yaml:

imports:
  - { resource: "@SyliusEasyCrudPlugin/config/config.yaml" }
  - { resource: "@SyliusHappyCMSPlugin/config/config.yaml" }

4. Import Routes

In config/routes.yaml:

sylius_happy_cms:
  resource: "@SyliusHappyCMSPlugin/config/routes.yaml"
  
sylius_easy_crud:
  resource: "@SyliusEasyCrudPlugin/config/routes.yaml"

5. Generate default files in your project (entities, repositories and admin classes) :

Actually, we don't have Symfony recipes, so we created a command to generate files automatically.

php bin/console make:happy-cms:install

This command will :

• Create all entities, repositories and admin class
• update config/routes.yaml by adding route properly declared
• update config/packages/sylius_resource.yaml by adding sylius routes properly declared
• update config/packages/sylius_happy_cms.yaml by adding new files properly declared

If something goes wrong, you can do those actions manually, check detailed configuration.

6. Install Assets

php bin/console assets:install

7. Update database

php bin/console doc:mig:diff
php bin/console doc:mig:mig
php bin/console cache:clear

At this point, the plugin should be installed and ready to use!

Documentation

• Configure Homepage
• Create custom routable entities
• Create custom CMS blocks
• Detailed default configuration
• How routing work

If this plugin helped you, please consider giving it a ⭐ on GitHub!

Made with ❤️ by Adeliom