teamneusta/pimcore-presentation-bundle

Allows to create online presentations in pimcore using reveal-js

v2.1.0 2024-12-05 07:59 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• pimcore/pimcore: ^10.5 || ^11.0
• symfony/config: ^5.3 || ^6.0
• symfony/console: ^5.3 || ^6.0
• symfony/dependency-injection: ^5.3 || ^6.0
• symfony/event-dispatcher: ^5.2 || ^6.0
• symfony/finder: ^5.2 || ^6.0
• symfony/http-kernel: ^5.3 || ^6.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.11
• jangregor/phpstan-prophecy: ^1.0
• phpspec/prophecy-phpunit: ^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.8
• phpstan/phpstan-phpunit: ^1.1
• phpstan/phpstan-symfony: ^1.2
• phpunit/phpunit: ^9.5
• teamneusta/pimcore-testing-framework: ^0.12.0

Conflicts

• presta/sitemap-bundle: <3.1
• symfony/form: <5.4
• symfony/proxy-manager-bridge: <5.4
• symfony/routing: <5.4

GPL-3.0-or-later

• team neusta GmbH

README

Allows to create online presentations in Pimcore using reveal-js.

Installation

1. Require the bundle

   composer require teamneusta/pimcore-presentation-bundle

2. Enable the bundle

   Add the Presentation Bundle to your config/bundles.php:

   Neusta\Pimcore\PresentationBundle\NeustaPimcorePresentationBundle::class => ['all' => true],

3. Install the bundle

   bin/console pimcore:bundle:install NeustaPimcorePresentationBundle

4. Install reveal.js

   After the Bundle is installed it is required to manually install reveal-js

   cd vendor/teamneusta/pimcore-presentation-bundle/public
   curl -OL https://github.com/hakimel/reveal.js/archive/master.zip
   unzip master.zip
   rm master.zip

Usage

Create new Pimcore document pages using the Document Types offered by this bundle. See documentation for more details

Configuration

The bundle provides a handful of simple areabricks for creating presentations. When the bundle is used together with other bundles, there may be collisions of areabrick names or you may simply not be interested in using the default bricks. It is possible to disable the included areabricks with the following configuration

neusta_pimcore_presentation:
    bricks: false

Contribution

Feel free to open issues for any bug, feature request, or other ideas.

Please remember to create an issue before creating large pull requests.

Local Development

To develop on local machine, the vendor dependencies are required.

bin/composer install

We use composer scripts for our main quality tools. They can be executed via the bin/composer file as well.

bin/composer cs:fix
bin/composer phpstan
bin/composer tests