Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 1.56 KB

README.md

File metadata and controls

56 lines (41 loc) · 1.56 KB
Raw

Contao 4 skeleton bundle

Contao is an Open Source PHP Content Management System for people who want a professional website that is easy to maintain. Visit the project website for more information.

You can use the skeleton bundle as basis for your own Contao bundle.

Install

Download the skeleton bundle:

wget https://github.com/contao/skeleton-bundle/archive/main.zip
unzip main.zip
mv skeleton-bundle-main [package name]
cd [package name]

Customize

First adjust the following files:

  • composer.json
  • ecs.php
  • LICENSE
  • phpunit.xml.dist
  • README.md

Then rename the following files and/or the references to SkeletonBundle in the following files:

  • src/ContaoManager/Plugin.php
  • src/DependencyInjection/ContaoSkeletonExtension.php
  • src/ContaoSkeletonBundle.php
  • tests/ContaoSkeletonBundleTest.php

Finally, add your custom classes and resources. Make sure to register your services within src/Resources/config/services.yml. Also make sure to adjust the Contao Manager Plugin (and the dependencies within the composer.json) accordingly, if your bundle makes adjustments to other bundles (e.g. adjustments to a DCA of other bundles).

Release

First make sure the tools are installed and up to date by running composer bin all update in your bundle's root. Then run the PHP-CS-Fixer and the unit test before you release your bundle:

vendor/bin/ecs check src/ tests/ --fix
vendor/bin/phpunit