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 split into separate packages automatically:
- CalendarBundle
- CommentsBundle
- CoreBundle
- FaqBundle
- InstallationBundle
- ListingBundle
- 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 dev-master
if you want to add a new feature or with <lts-version>.x-dev
(currently
4.4.x-dev
and 4.9.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": "^7.2",
"contao/contao": "dev-master"
},
Again, use dev-master
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 your setup by opening
https://your-domain.local/contao/install
in your browser.
All the changes you make in vendor/contao/contao
are be tracked via Git, so
you can submit your pull request directly from within your application.
Running scripts
You can use Composer to run the code quality scripts:
composer run all
composer run unit-tests
composer run cs-fixer
composer run phpstan
composer run psalm
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 functional tests, create a database named contao_test
and import
the core-bundle/tests/Functional/app/Resources/contao_test.sql
file.
mysql -e "CREATE DATABASE contao_test"
mysql contao_test < core-bundle/tests/Functional/app/Resources/contao_test.sql
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
License
Contao is licensed under the terms of the LGPLv3.
Getting support
Visit the support page to learn about the available support options.