diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 0e1fc913..2e9fe610 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -21,6 +21,14 @@ system and detailed information on how to install TYPO3. :class: pb-4 :card-height: 100 + .. card:: Prerequisites + + In this section we mention the prerequisites that you need before + you start with this tutorial. + + .. card-footer:: :ref:`See the prerequisites ` + :button-style: btn btn-secondary stretched-link + .. card:: Concepts Written for new users, this chapter introduces some of TYPO3's core @@ -29,9 +37,6 @@ system and detailed information on how to install TYPO3. .. card-footer:: :ref:`Learn about the basic concepts ` :button-style: btn btn-secondary stretched-link - .. card-footer:: :ref:`Learn more about TYPO3 Concepts ` - :button-style: btn btn-secondary stretched-link - .. card:: Installation The installation chapter provides detailed instructions on how to diff --git a/Documentation/Prerequisites/Index.rst b/Documentation/Prerequisites/Index.rst new file mode 100644 index 00000000..a1737763 --- /dev/null +++ b/Documentation/Prerequisites/Index.rst @@ -0,0 +1,73 @@ +:navigation-title: Prerequisites +.. include:: /Includes.rst.txt + +.. _prerequisites: + +================================= +Prerequisites to start with TYPO3 +================================= + +Before you start working on this tutorial, you should have DDEV installed on +your computer. + +This TYPO3 tutorial assumes that the reader has some basic knowledge in the following areas: + +* `HTML, CSS and JavaScript `__ +* `PHP `__ +* Basic CLI Commands + +.. _roadmap: + +What you will learn in this tutorial +==================================== + + + +.. _composer_cheat_sheat: + +Composer cheat sheet +==================== + +Composer is a powerful tool for managing dependencies in PHP projects, including +TYPO3. Here you will find an overview of the four most important commands with a +simple explanation of what they do. + +#. composer require + + .. code-block:: bash + + composer require vendor/extension-name + + It installs a new package (e.g. a TYPO3 extension) and automatically adds it to your :guilabel:`composer.json`. + Composer determines the appropriate version based on your current configuration. + All required dependencies for the package are also installed. + +#. composer remove + + .. code-block:: bash + + composer remove vendor/extension-name + + Uninstalls an existing package from your project. + Removes the entry from :guilabel:`composer.json` and deletes related files from the + :guilabel:`vendor` folder. + Removes unused dependencies that were only required fro the removed package. + +#. composer install + + .. code-block:: bash + + composer install + + It installs exactly the versions specified in the :guilabel:`composer.lock` file. + +#. composer update + + .. code-block:: bash + + composer update + + It updates all installed packages to their latest version, as allowed by the version constraints in :guilabel:`composer.json`. + The :guilabel:`composer.lock` file, which records the exact package versions, is updated. + Downloads the updated packages to the :guilabel:`vendor` folder. +