Repository files navigation

Contao is a powerful open source CMS that allows you to create professional websites and scalable web applications.Visit theproject 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 pullrequest or report an issue.

The monorepo is automatically split into separate packages:

• CalendarBundle
• CommentsBundle
• CoreBundle
• FaqBundle
• ListingBundle
• MakerBundle
• ManagerBundle
• NewsBundle
• NewsletterBundle

Please do not usecontao/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 theContao 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 currentdirectory). Replace<branch> with5.x-dev if you want to add a new feature, or with<lts-version>.x-dev (currently5.3.x-dev) if you want to fix a bug.

Then adjust therequire section in yourcomposer.json file, so Composer loads the monorepo instead of the individualbundles:

"require": {"php":"^8.2","contao/contao":"5.x-dev"},

Again, use5.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 automatically clones the Git repository into thevendor/contao/contao folder. You can complete the setup byrunningvendor/bin/contao-setup on the command line.

Any changes you make invendor/contao/contao will be tracked via Git, so you can submit your pull request directlyfrom your application.

First install the code quality tools invendor/contao/contao:

composer updatecomposer bin all install

Then run the code quality scripts via Composer:

composer all

You can also run the scripts separately:

composer rectorcomposer ecscomposer service-lintercomposer monorepo-toolscomposer unit-testscomposer functional-testscomposer phpstancomposer depcheck

Use the-- argument to pass additional flags to the underlying commands:

composer unit-tests -- --filter CoreBundlecomposer ecs -- --clear-cache

To set up the functional tests, create a database namedcontao_test:

mysql -e"CREATE DATABASE contao_test"

If your database uses credentials, copy the filecore-bundle/phpunit.xml.dist tocore-bundle/phpunit.xml and adjustthe following line:

<php>    <envname="DATABASE_URL"value="mysql://root@localhost:3306/contao_test" /></php>

Then run the functional tests via Composer:

composer functional-tests

To build the assets, you need a Node.js version >= 18.12. Then run these commands:

npm cinpm run build

The Contao end-to-end tests are availabe as anNPM package. You caninstall and run them like this:

npm install contao-e2e-tests --save-devnpx contao-e2e-tests

Contao is licensed under the terms of the LGPLv3.

• Thanks toJetBrains for kindly providing licenses for their products.
• Thanks toBlackfire for kindly providing a free open source subscription.
• This project is tested withBrowserStack.

Visit thesupport page to learn about the available support options.