radiofrance/cellulr-engine

Engine for CellulR

CellulR Engine

CellulR is an engine to build websites. Each page is composed from isolated and independent cells., _(*1)

This project is production ready, and is used on www.franceculture.fr ., _(*2)

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

How it works ?

1. Rendering, _(*4)

Render a cell 'VideoPlayer' in current page, with Twig :, _(*5)

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

Or using Varnish ESI (with standalone route):, _(*6)

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

2. The cell, _(*7)

<?php

use Rf\CellulR\EngineBundle\CoreObject\Response;

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

3. Manifest file, _(*8)

The component.json declares dependencies (with other cells) :, _(*9)

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

4. Assets (Javascript and Less), _(*10)

Less files and JavaScript files are automatically included thanks to the cellulR-builder component., _(*11)

Installation and documentation

[French only] Documentation, _(*12)

Do not hesitate to help us to translate documentation in english :), _(*13)

Licence

Project licensed under Cecill-B license. Please open the LICENSE file., _(*14)