name mode size
config 040000
contao 040000
src 040000
tests 040000
tools 040000
.editorconfig 100644 348B
.gitignore 100644 107B
LICENSE 100644 7.65kB
README.md 100644 1.47kB
composer.json 100644 1.96kB
composer.phar 100644 2.84MB
ecs.php 100644 883B
phpstan.neon 100644 541B
phpunit.xml.dist 100644 557B
README.md
# 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][1] for more information. You can use the skeleton bundle as basis for your own Contao bundle. ## Install Download the skeleton bundle: ```bash 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][2] (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 Run the PHP-CS-Fixer and the unit test before you release your bundle: ```bash vendor/bin/ecs check src/ tests/ --fix vendor/bin/phpunit ``` [1]: https://contao.org [2]: https://docs.contao.org/dev/framework/manager-plugin/#the-bundleplugininterface