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.
The purpose of this package is to develop the Contao bundles in a monorepo. Use it when you want to create a pull request or 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.
Thanks to our platinum partners for helping us fund the development of Contao.
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 where you want to install the Managed Edition (use . for the current
directory). 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.1",
"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 updateComposer automatically clones the Git repository into the vendor/contao/contao folder. You can complete the setup by
running vendor/bin/contao-setup on the command line.
Any changes you make in vendor/contao/contao will be tracked via Git, so you can submit your pull request directly
from your application.
First install the code quality tools:
composer bin all installThen run the code quality scripts via Composer:
composer allYou can also run the scripts separately:
composer rector
composer ecs
composer service-linter
composer monorepo-tools
composer unit-tests
composer functional-tests
composer phpstan
composer depcheckUse the -- argument to pass additional flags to the underlying commands:
composer unit-tests -- --filter CoreBundle
composer ecs -- --clear-cacheTo 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 Composer:
composer functional-testsTo build the assets, you need a Node.js version >= 18.12. Then run these commands:
npm ci
npm run buildThe Contao end-to-end tests are availabe as an NPM package. You can install and run them like this:
npm install contao-e2e-tests --save-dev
npx contao-e2e-testsContao is licensed under the terms of the LGPLv3.
Visit the support page to learn about the available support options.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent