|
| 1 | +:navigation-title: Prerequisites |
| 2 | +.. include:: /Includes.rst.txt |
| 3 | + |
| 4 | +.. _prerequisites: |
| 5 | + |
| 6 | +================================= |
| 7 | +Prerequisites to start with TYPO3 |
| 8 | +================================= |
| 9 | + |
| 10 | +Before you start working on this tutorial, you should have DDEV installed on |
| 11 | +your computer. |
| 12 | + |
| 13 | +This TYPO3 tutorial assumes that the reader has some basic knowledge in the following areas: |
| 14 | + |
| 15 | +* `HTML, CSS and JavaScript <https://www.w3schools.com/html/default.asp>`__ |
| 16 | +* `Basic Command Line Interface (CLI) Commands <https://www.w3schools.com/whatis/whatis_cli.asp>`__ |
| 17 | + |
| 18 | +.. _composer_cheat_sheat: |
| 19 | + |
| 20 | +Composer cheat sheet |
| 21 | +==================== |
| 22 | + |
| 23 | +Composer is a powerful tool for managing dependencies in PHP projects, including |
| 24 | +TYPO3. Here you will find an overview of the four most important commands with a |
| 25 | +simple explanation of what they do. |
| 26 | + |
| 27 | +.. _composer_require: |
| 28 | + |
| 29 | +composer require |
| 30 | +---------------- |
| 31 | + |
| 32 | +.. code-block:: bash |
| 33 | +
|
| 34 | + composer require vendor/extension-name |
| 35 | +
|
| 36 | +It installs a new package (e.g. a TYPO3 extension) and automatically adds it to your :guilabel:`composer.json`. |
| 37 | +Composer determines the appropriate version based on your current configuration. |
| 38 | +All required dependencies for the package are also installed. |
| 39 | + |
| 40 | +.. _composer_remove: |
| 41 | + |
| 42 | +composer remove |
| 43 | +--------------- |
| 44 | + |
| 45 | +.. code-block:: bash |
| 46 | +
|
| 47 | + composer remove vendor/extension-name |
| 48 | +
|
| 49 | +Uninstalls an existing package from your project. |
| 50 | +Removes the entry from :guilabel:`composer.json` and deletes related files from the |
| 51 | +:guilabel:`vendor` folder. |
| 52 | +Removes unused dependencies that were only required fro the removed package. |
| 53 | + |
| 54 | +.. _composer_install: |
| 55 | + |
| 56 | +composer install |
| 57 | +---------------- |
| 58 | + |
| 59 | +.. code-block:: bash |
| 60 | +
|
| 61 | + composer install |
| 62 | +
|
| 63 | +It installs exactly the versions specified in the :guilabel:`composer.lock` file. |
| 64 | + |
| 65 | +.. _composer_update: |
| 66 | + |
| 67 | +composer update |
| 68 | +--------------- |
| 69 | + |
| 70 | +.. code-block:: bash |
| 71 | +
|
| 72 | + composer update |
| 73 | +
|
| 74 | +It updates all installed packages to their latest version, as allowed by the version constraints in :guilabel:`composer.json`. |
| 75 | +The :guilabel:`composer.lock` file, which records the exact package versions, is updated. |
| 76 | +Downloads the updated packages to the :guilabel:`vendor` folder. |
| 77 | + |
0 commit comments