contao / contao
Contao Open Source CMS development package
Fund package maintenance!
Other
Installs: 13 040
Dependents: 2
Suggesters: 0
Security: 17
Stars: 318
Watchers: 43
Forks: 155
Open Issues: 380
Type:symfony-bundle
Requires
- php: ^8.1
- composer-runtime-api: ^2.0.14
- ext-dom: *
- ext-filter: *
- ext-gd: *
- ext-hash: *
- ext-intl: *
- ext-json: *
- ext-pcre: *
- ext-pdo: *
- ext-session: *
- ext-zlib: *
- ausi/slug-generator: ^1.1
- bacon/bacon-qr-code: ^2.0
- contao-components/ace: ^1.8
- contao-components/chosen: ^2.0
- contao-components/colorbox: ^1.6
- contao-components/colorpicker: ^1.5
- contao-components/contao: ^9.1
- contao-components/datepicker: ^3.0
- contao-components/dropzone: ^5.0.1
- contao-components/handorgel: ^1.0
- contao-components/jquery: ^3.5
- contao-components/jquery-ui: ^1.11.4
- contao-components/mediabox: ^1.5
- contao-components/mootools: ^1.6.0.1
- contao-components/simplemodal: ^3.0
- contao-components/swipe: ^2.0.3
- contao-components/swiper: ^11.0
- contao-components/tablesort: ^4.0
- contao-components/tablesorter: ^2.1
- contao-components/tinymce4: ^5.0 || ^6.0
- contao-components/tristen-tablesort: ^5.3
- contao/image: ^1.2
- contao/imagine-svg: ^1.0
- contao/manager-plugin: ^2.6.2
- debril/feed-io: ^6.0
- doctrine/collections: ^2.1
- doctrine/dbal: ^3.6
- doctrine/doctrine-bundle: ^2.8
- doctrine/orm: ^2.17
- doctrine/persistence: ^3.2
- dragonmantank/cron-expression: ^2.3
- friendsofsymfony/http-cache: ^2.15.1
- friendsofsymfony/http-cache-bundle: ^2.6
- guzzlehttp/promises: ^1.5
- imagine/imagine: ^1.2.4
- knplabs/knp-menu: ^3.1
- knplabs/knp-menu-bundle: ^3.0
- knplabs/knp-time-bundle: ^1.11 || ^2.0
- lcobucci/jwt: ^4.0
- league/commonmark: ^2.2
- league/flysystem: ^3.0
- league/flysystem-bundle: ^3.0
- matthiasmullie/minify: ^1.3
- monolog/monolog: ^2.0
- nelmio/cors-bundle: ^2.0.1
- nelmio/security-bundle: ^3.0
- nikic/php-parser: ^4.9
- nyholm/psr7: ^1.2
- paragonie/constant_time_encoding: ^2.2
- phpspec/php-diff: ^1.0
- phpunit/phpunit: ^9.5.19
- psr/cache: ^3.0
- psr/container: ^2.0
- psr/http-message: ^1.0 || ^2.0
- psr/log: ^1.1 || 2.0 || ^3.0
- scheb/2fa-backup-code: ^6.0
- scheb/2fa-bundle: ^6.0
- scheb/2fa-trusted-device: ^6.0
- scrivo/highlight.php: ^9.18
- scssphp/scssphp: ^1.5
- simplepie/simplepie: ^1.3
- spatie/schema-org: ^3.4
- spomky-labs/otphp: ^10.0
- symfony-cmf/routing: ^3.0
- symfony-cmf/routing-bundle: ^3.0
- symfony/asset: ^6.4
- symfony/cache: ^6.4
- symfony/cache-contracts: ^3.0
- symfony/config: ^6.4
- symfony/console: ^6.4
- symfony/debug-bundle: ^6.4
- symfony/dependency-injection: ^6.4
- symfony/deprecation-contracts: ^3.0
- symfony/doctrine-bridge: ^6.4
- symfony/doctrine-messenger: ^6.4
- symfony/dom-crawler: ^6.4
- symfony/dotenv: ^6.4
- symfony/error-handler: ^6.4
- symfony/event-dispatcher: ^6.4
- symfony/event-dispatcher-contracts: ^3.0
- symfony/expression-language: ^6.4
- symfony/filesystem: ^6.4
- symfony/finder: ^6.4
- symfony/framework-bundle: ^6.4
- symfony/html-sanitizer: ^6.4
- symfony/http-client: ^6.4
- symfony/http-client-contracts: ^3.1
- symfony/http-foundation: ^6.4
- symfony/http-kernel: ^6.4
- symfony/intl: ^6.4
- symfony/lock: ^6.4
- symfony/mailer: ^6.4
- symfony/maker-bundle: ^1.1
- symfony/messenger: ^6.4
- symfony/mime: ^6.4
- symfony/monolog-bridge: ^6.4
- symfony/monolog-bundle: ^3.1
- symfony/options-resolver: ^6.4
- symfony/password-hasher: ^6.4
- symfony/polyfill-intl-idn: ^1.0
- symfony/polyfill-mbstring: ^1.0
- symfony/process: ^6.4
- symfony/property-access: ^6.4
- symfony/rate-limiter: ^6.4
- symfony/routing: ^6.4
- symfony/security-bundle: ^6.4
- symfony/security-core: ^6.4
- symfony/security-csrf: ^6.4
- symfony/security-http: ^6.4
- symfony/service-contracts: ^3.0
- symfony/stopwatch: ^6.4
- symfony/string: ^6.4
- symfony/translation: ^6.4
- symfony/translation-contracts: ^3.0
- symfony/twig-bridge: ^6.4
- symfony/twig-bundle: ^6.4
- symfony/uid: ^6.4
- symfony/var-dumper: ^6.4
- symfony/web-profiler-bundle: ^6.4
- symfony/yaml: ^6.4
- terminal42/escargot: ^1.6
- terminal42/service-annotation-bundle: ^1.1
- tijsverkoyen/css-to-inline-styles: ^2.0
- toflar/cronjob-supervisor: ^1.0
- toflar/psr6-symfony-http-cache-store: ^4.0
- twig/extra-bundle: ^3.0
- twig/string-extra: ^3.0
- twig/twig: ^3.8
- ua-parser/uap-php: ^3.9
- webignition/robots-txt-file: ^3.0
- wikimedia/less.php: ^1.7
Requires (Dev)
- ext-fileinfo: *
- bamarni/composer-bin-plugin: ^1.4
- composer/composer: ^2.0
- league/flysystem-memory: ^3.0
- symfony/browser-kit: ^6.4
- symfony/phpunit-bridge: ^6.4
Conflicts
- contao-community-alliance/composer-plugin: <3.0
- contao/core: *
- contao/manager-plugin: <2.0 || >=3.0
- doctrine/annotations: <1.9
- doctrine/cache: <1.10
- nikic/php-parser: 4.7.0
- terminal42/contao-ce-access: <3.0
- thecodingmachine/safe: <1.2
- zendframework/zend-code: <3.3.1
Replaces
- contao/calendar-bundle: 5.3.1
- contao/comments-bundle: 5.3.1
- contao/core-bundle: 5.3.1
- contao/faq-bundle: 5.3.1
- contao/listing-bundle: 5.3.1
- contao/maker-bundle: 5.3.1
- contao/manager-bundle: 5.3.1
- contao/news-bundle: 5.3.1
- contao/newsletter-bundle: 5.3.1
- contao/test-case: 5.3.1
- 5.x-dev
- 5.3.x-dev
- 5.3.1
- 5.3.0
- 5.3.0-RC4
- 5.3.0-RC3
- 5.3.0-RC2
- 5.3.0-RC1
- 5.2.10
- 5.2.9
- 5.2.8
- 5.2.7
- 5.2.6
- 5.2.5
- 5.2.4
- 5.2.3
- 5.2.2
- 5.2.1
- 5.2.0
- 5.2.0-RC6
- 5.2.0-RC5
- 5.2.0-RC4
- 5.2.0-RC3
- 5.2.0-RC2
- 5.2.0-RC1
- 5.1.11
- 5.1.10
- 5.1.9
- 5.1.8
- 5.1.7
- 5.1.6
- 5.1.5
- 5.1.4
- 5.1.3
- 5.1.2
- 5.1.1
- 5.1.0
- 5.1.0-RC3
- 5.1.0-RC2
- 5.1.0-RC1
- 5.0.10
- 5.0.9
- 5.0.8
- 5.0.7
- 5.0.6
- 5.0.5
- 5.0.4
- 5.0.3
- 5.0.2
- 5.0.1
- 5.0.0
- 5.0.0-RC4
- 5.0.0-RC3
- 5.0.0-RC2
- 5.0.0-RC1
- 4.13.x-dev
- 4.13.38
- 4.13.37
- 4.13.36
- 4.13.35
- 4.13.34
- 4.13.33
- 4.13.32
- 4.13.31
- 4.13.30
- 4.13.29
- 4.13.28
- 4.13.27
- 4.13.26
- 4.13.25
- 4.13.24
- 4.13.23
- 4.13.22
- 4.13.21
- 4.13.20
- 4.13.19
- 4.13.18
- 4.13.17
- 4.13.16
- 4.13.15
- 4.13.14
- 4.13.13
- 4.13.12
- 4.13.11
- 4.13.10
- 4.13.9
- 4.13.8
- 4.13.7
- 4.13.6
- 4.13.5
- 4.13.4
- 4.13.3
- 4.13.2
- 4.13.1
- 4.13.0
- 4.13.0-RC3
- 4.13.0-RC2
- 4.13.0-RC1
- 4.12.7
- 4.12.6
- 4.12.5
- 4.12.4
- 4.12.3
- 4.12.2
- 4.12.1
- 4.12.0
- 4.12.0-RC3
- 4.12.0-RC2
- 4.12.0-RC1
- 4.11.9
- 4.11.8
- 4.11.7
- 4.11.6
- 4.11.5
- 4.11.4
- 4.11.3
- 4.11.2
- 4.11.1
- 4.11.0
- 4.11.0-RC2
- 4.11.0-RC1
- 4.10.7
- 4.10.6
- 4.10.5
- 4.10.4
- 4.10.3
- 4.10.2
- 4.10.1
- 4.10.0
- 4.10.0-RC4
- 4.10.0-RC3
- 4.10.0-RC2
- 4.10.0-RC1
- 4.9.42
- 4.9.41
- 4.9.40
- 4.9.39
- 4.9.38
- 4.9.37
- 4.9.36
- 4.9.35
- 4.9.34
- 4.9.33
- 4.9.32
- 4.9.31
- 4.9.30
- 4.9.29
- 4.9.28
- 4.9.27
- 4.9.26
- 4.9.25
- 4.9.24
- 4.9.23
- 4.9.22
- 4.9.21
- 4.9.20
- 4.9.19
- 4.9.18
- 4.9.17
- 4.9.16
- 4.9.15
- 4.9.14
- 4.9.13
- 4.9.12
- 4.9.11
- 4.9.10
- 4.9.9
- 4.9.8
- 4.9.7
- 4.9.6
- 4.9.5
- 4.9.4
- 4.9.3
- 4.9.2
- 4.9.1
- 4.9.0
- 4.9.0-RC2
- 4.9.0-RC1
- 4.8.8
- 4.8.7
- 4.8.6
- 4.8.5
- 4.8.4
- 4.8.3
- 4.8.2
- 4.8.1
- 4.8.0
- 4.8.0-RC2
- 4.8.0-RC1
- 4.7.7
- 4.7.6
- 4.7.5
- 4.7.4
- 4.7.3
- 4.7.2
- 4.7.1
- 4.7.0
- 4.7.0-RC4
- 4.7.0-RC3
- 4.7.0-RC2
- 4.7.0-RC1
- 4.6.14
- 4.6.13
- 4.6.12
- 4.6.11
- 4.6.10
- 4.6.9
- 4.6.8
- 4.6.7
- 4.6.6
- 4.6.5
- 4.6.4
- 4.6.3
- 4.6.2
- 4.6.1
- 4.6.0
- 4.5.14
- 4.5.13
- 4.4.57
- 4.4.56
- 4.4.55
- 4.4.54
- 4.4.53
- 4.4.52
- 4.4.51
- 4.4.50
- 4.4.49
- 4.4.48
- 4.4.47
- 4.4.46
- 4.4.45
- 4.4.44
- 4.4.43
- 4.4.42
- 4.4.41
- 4.4.40
- 4.4.39
- 4.4.38
- 4.4.37
- 4.4.36
- 4.4.35
- 4.4.34
- 4.4.33
- 4.4.32
- 4.4.31
- 4.4.30
- 4.4.29
- 4.4.28
- 4.4.27
- 4.4.26
- 4.4.25
- 4.4.24
- 4.4.23
- 4.4.22
This package is auto-updated.
Last update: 2024-03-18 11:05:06 UTC
README
About
Contao is a powerful open source CMS that allows you to create professional websites and scalable web applications. Visit the project website for more information.
Purpose
The purpose of this package is to develop the Contao bundles. Use it if you e.g. want to create a pull request or if you want to report an issue.
The monorepo is automatically split into separate packages:
- CalendarBundle
- CommentsBundle
- CoreBundle
- FaqBundle
- ListingBundle
- MakerBundle
- ManagerBundle
- NewsBundle
- NewsletterBundle
Please do not use contao/contao
in production! Use the split packages instead.
Development
To create a pull request and to test your changes within a running Contao application, it is the easiest to use the Contao Managed Edition. Start by installing it in your current directory:
composer create-project --no-install contao/managed-edition <directory> <branch>
Replace <directory>
with the directory you want to install the Managed Edition in (use .
for the current one).
Replace <branch>
with 5.x-dev
if you want to add a new feature or with <lts-version>.x-dev
(currently
4.13.x-dev
) if you want to fix a bug.
Then adjust the require
section in your composer.json
file, so Composer loads the monorepo instead of the individual
bundles:
"require": { "php": "^8.0", "contao/contao": "5.x-dev" },
Again, use 5.x-dev
if you want to add a new feature or <lts-version>.x-dev
if you want to fix a bug.
Next, install the dependencies:
composer update
Composer will automatically clone the Git repo into the vendor/contao/contao
folder. You can finish the setup by
running vendor/bin/contao-setup
on the command line.
All the changes you make in vendor/contao/contao
are tracked via Git, so you can submit your pull request directly
from within your application.
Running scripts
First install the code quality tools:
composer bin all install
Then run the code quality scripts via Composer:
composer run all
You can also run the scripts separately:
composer run rector composer run cs-fixer composer run service-linter composer run monorepo-tools composer run unit-tests composer run functional-tests composer run phpstan composer run require-checker
If you want to pass additional flags to the underlying commands, you can use the --
argument:
composer run unit-tests -- --filter CoreBundle composer run cs-fixer -- --clear-cache
Functional tests
To set up the functional tests, create a database named contao_test
:
mysql -e "CREATE DATABASE contao_test"
If your database uses credentials, copy the file core-bundle/phpunit.xml.dist
to core-bundle/phpunit.xml
and adjust
the following line:
<php> <env name="DATABASE_URL" value="mysql://root@localhost:3306/contao_test" /> </php>
Then run the functional tests via the run
command:
composer run functional-tests
Yarn 4
To build the assets and to run the end-to-end tests (see below), you need to enable Corepack, a package manager that allows you to manage different Yarn package versions across multiple projects:
corepack enable
If Corepack is not bundled with your Node.js installation, you might have to install it as a separate package, e.g.
using npm install -g corepack
or brew install corepack
.
End-to-end tests
Before you can run the end-to-end tests, you have to install the Symfony Local Web Server with TLS support. Then install the required Node packages and run the end-to-end tests:
yarn install yarn run e2e-tests
License
Contao is licensed under the terms of the LGPLv3.
Getting support
Visit the support page to learn about the available support options.