radiofrance/cellulr-engine

Engine for CellulR

v4.0.2-beta-1 2018-05-23 08:29 UTC

Requires

• php: >=5.4
• dunglas/action-bundle: ^0.3.0
• limenius/react-renderer: ^0.14.0
• sensio/framework-extra-bundle: ~2.8|~3.0
• symfony/config: ~2.8|~3.0
• symfony/dependency-injection: ~2.8|~3.0
• symfony/expression-language: ~2.8|~3.1
• symfony/finder: ~2.8|~3.0
• symfony/http-kernel: ~2.8|~3.0
• symfony/monolog-bundle: ~2.4
• symfony/templating: ~2.8|~3.1
• symfony/twig-bundle: ~2.8|~3.1
• twig/extensions: ~1.0

Requires (Dev)

• phpunit/phpunit: 5.3.2
• symfony/browser-kit: >=2.4

CECILL-B

• Nans Pellicari
• Radio France

• symfony-bundle
• CellulR

README

CellulR is an engine to build websites. Each page is composed from isolated and independent cells.

This project is production ready, and is used on www.franceculture.fr .

Each cell is isolated and autonomous. A cell is composed of (at least) one PHP Controller, JavaScript and CSS files.

How it works ?

1. Rendering

Render a cell 'VideoPlayer' in current page, with Twig :

{{ cell('VideoPlayer', {arg1: 'a value'}) }}

Or using Varnish ESI (with standalone route):

{{ cell('VideoPlayer', {arg1: 'a value'}, {strategy: 'esi'}) }}

2. The cell

<?php

use Rf\CellulR\EngineBundle\CoreObject\Response;

class VideoPlayer
{
    public function __invoke(Video $video) {
        return new Response([
            'video' => $video
        ]); 
    }
}

3. Manifest file

The component.json declares dependencies (with other cells) :

{
    "name": "VideoPlayer",
    "description": "Cell for video player",
    "require": {
        "Legend": "*",
        "Image": "*"
    }
}

4. Assets (Javascript and Less)

Less files and JavaScript files are automatically included thanks to the cellulR-builder component.

Installation and documentation

[French only] Documentation

Do not hesitate to help us to translate documentation in english :)

Licence

Project licensed under Cecill-B license. Please open the LICENSE file.