Git Product home page Git Product logo

contao's Introduction

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.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": "^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 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 unit-tests
composer run functional-tests
composer run cs-fixer
composer run service-linter
composer run phpstan
composer run require-checker
composer run monorepo-tools

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

License

Contao is licensed under the terms of the LGPLv3.

Getting support

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

contao's People

Contributors

leofeyer avatar aschempp avatar ausi avatar toflar avatar fritzmg avatar m-vo avatar tristanlins avatar xchs avatar bytehead avatar discordier avatar qzminski avatar dmolineus avatar marcobiedermann avatar rabauss avatar bezin avatar psi-4ward avatar richardhj avatar severingloeckle avatar dominikzogg avatar mynyx avatar serhii-dv avatar backbone87 avatar dennisbohn avatar cliffparnitzky avatar a-v-l avatar frontendschlampe avatar volkerrichert avatar ameotoko avatar gmpf avatar tastaturberuf avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.