Skip to content

Commit 6d5390e

Browse files
Kiebelegithub-actions[bot]
authored andcommitted
[TASK] Add prerequisites
1 parent 2dfb8a4 commit 6d5390e

File tree

2 files changed

+81
-3
lines changed

2 files changed

+81
-3
lines changed

Documentation/Index.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ system and detailed information on how to install TYPO3.
2121
:class: pb-4
2222
:card-height: 100
2323

24+
.. card:: Prerequisites
25+
26+
In this section we mention the prerequisites that you need before
27+
you start with this tutorial.
28+
29+
.. card-footer:: :ref:`See the prerequisites <Prerequisites>`
30+
:button-style: btn btn-secondary stretched-link
31+
2432
.. card:: Concepts
2533

2634
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.
2937
.. card-footer:: :ref:`Learn about the basic concepts <Concepts>`
3038
:button-style: btn btn-secondary stretched-link
3139

32-
.. card-footer:: :ref:`Learn more about TYPO3 Concepts <Concepts>`
33-
:button-style: btn btn-secondary stretched-link
34-
3540
.. card:: Installation
3641

3742
The installation chapter provides detailed instructions on how to
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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+
* `PHP <https://www.w3schools.com/php/default.asp>`__
17+
* Basic CLI Commands
18+
19+
.. _roadmap:
20+
21+
What you will learn in this tutorial
22+
====================================
23+
24+
25+
26+
.. _composer_cheat_sheat:
27+
28+
Composer cheat sheet
29+
====================
30+
31+
Composer is a powerful tool for managing dependencies in PHP projects, including
32+
TYPO3. Here you will find an overview of the four most important commands with a
33+
simple explanation of what they do.
34+
35+
#. composer require
36+
37+
.. code-block:: bash
38+
39+
composer require vendor/extension-name
40+
41+
It installs a new package (e.g. a TYPO3 extension) and automatically adds it to your :guilabel:`composer.json`.
42+
Composer determines the appropriate version based on your current configuration.
43+
All required dependencies for the package are also installed.
44+
45+
#. composer remove
46+
47+
.. code-block:: bash
48+
49+
composer remove vendor/extension-name
50+
51+
Uninstalls an existing package from your project.
52+
Removes the entry from :guilabel:`composer.json` and deletes related files from the
53+
:guilabel:`vendor` folder.
54+
Removes unused dependencies that were only required fro the removed package.
55+
56+
#. composer install
57+
58+
.. code-block:: bash
59+
60+
composer install
61+
62+
It installs exactly the versions specified in the :guilabel:`composer.lock` file.
63+
64+
#. composer update
65+
66+
.. code-block:: bash
67+
68+
composer update
69+
70+
It updates all installed packages to their latest version, as allowed by the version constraints in :guilabel:`composer.json`.
71+
The :guilabel:`composer.lock` file, which records the exact package versions, is updated.
72+
Downloads the updated packages to the :guilabel:`vendor` folder.
73+

0 commit comments

Comments
 (0)