contao/contao

Contao Open Source CMS development package

Fund package maintenance!
Other

Installs: 12 973

Dependents: 2

Suggesters: 0

Security: 17

Stars: 313

Watchers: 43

Forks: 158

Open Issues: 372

Type:symfony-bundle

5.3.0 2024-02-16 11:16 UTC

This package is auto-updated.

Last update: 2024-02-20 10:51:10 UTC


README

68747470733a2f2f636f6e74616f2e6f72672f66696c65732f636f6e74616f2f6c6f676f2f636f6e74616f2d6c6f676f2d636f72706f726174652e737667

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:

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.