qzminski / contao

Contao 4 bundles

About

This is a monorepo holding the official Contao 4 bundles.

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.

Purpose

The purpose of this package is to develop the Contao 4 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 but use the split packages instead.

Development

To create a pull request and to test your changes within a running Contao 4 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) and <branch> with dev-master if you want to add a new feature or with <lts-version>.x-dev (currently 4.4.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.1",
    "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 visiting https://your-domain.local/contao/install.

All the changes you make in vendor/contao/contao can be tracked via Git and you can submit your pull request directly from within your application.

Running scripts

You can use the run command to run scripts in all bundles:

./run phpunit
./run php-cs-fixer

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 add the following lines:

<php>
    <env name="DB_HOST" value="localhost" />
    <env name="DB_USER" value="…" />
    <env name="DB_PASS" value="…" />
    <env name="DB_NAME" value="contao_test" />
</php>

Then run the functional tests via the run command:

./run functional

License

Contao is licensed under the terms of the LGPLv3.

Getting support

Visit the support page to learn about the available support options.