Setting Up Your Local Environment/de: Difference between revisions

Latest revision as of 05:39, 28 May 2024

Tutorial - Wie eine lokale Entwicklungsumgebung für Joomla! 4 eingerichtet wird

Joomla!

4.x

Mit Joomla! 4 wurde der Entwicklungsprozess verändert. Es ist nicht länger möglich, das Repository zu klonen und so Joomla! zu installieren. Im Folgenden ist nach aktuellen Erfahrungswerten ein funktionaler Weg zur Installation beschrieben.

Schnellstart-Anweisungen

Abhängig vom Betriebssystem unterscheidet sich die Einrichtung der Entwicklungsumgebung. Es ist leider nicht möglich, den Vorgang für die verschiedenen Betriebssysteme zu dokumentieren. Die bevorzugte Suchmaschine wird hier weiterhelfen.

Benötigte Werkzeuge

PHP - im Wesentlichen dasselbe wie beim Betreiben einer Joomla!-Seite, allerdings brauchst du eine spezielle Version, die PHP CLI (Kommandozeileneingabe) (beachte auch die Seite Einrichten eines LAMPP-Servers für die PHP-Entwicklung)
Composer - um die Abhängigkeiten von Joomla!s PHP zu verwalten. Hilfe bei der Installation von Composer bietet die Dokumentation auf https://getcomposer.org/doc/00-intro.md
Node.js - um JavaScript- und SASS-Dateien für Joomla! zu kompilieren - Hilfe bei der Installation von Node.js bieten die Anweisungen, die auf https://nodejs.org/en/ erhältlich sind. Hinweis: Für die Installation von Joomla wird mindestens NodeJS 12 benötigt.
Git - für die Versionsverwaltung.

Schritt für Schritt zur Installation der lokalen Entwicklungsumgebung

Das Repository klonen
Zum Branch der aktuellen Version wechseln (derzeit 4.3-dev)
Die Installation von composer install im Stammverzeichnis des Git-Repositorys ausführen. (Man kann --ignore-platform-reqs hinzufügen, wenn man das PHP-LDAP nicht lokal installiert hat und es nicht benötigt.)
Im Stammverzeichnis des Git-Repositorys npm ci ausführen. (Bitte beachten, dass dafür npm 6.13.4 oder höher benötigt wird. Um die npm-Version auf die LTS-Version zu aktualisieren, sollte npm install -g npm@lts ausgeführt werden. Für Joomla 5 wird npm 10.1.0 oder höher benötigt. Tipp: Mit nvm (Node Version Manager) kann man leicht zu anderen npm-Versionen wechseln).

Linux und OSX Benutzer können den folgenden Bash-Alias nutzen und ihn in der ~/.bashrc-Datei setzen:

alias jclean="rm -rf administrator/templates/atum/css; \
rm -rf templates/cassiopeia/css; \
rm -rf administrator/templates/system/css; \
rm -rf templates/system/css; \
rm -rf media/; \
rm -rf node_modules/; \
rm -rf libraries/vendor/; \
rm -f administrator/cache/autoload_psr4.php; \
rm -rf installation/template/css"
alias jinstall="jclean; composer install; npm ci"

Das wird alle kompilierten Dateien im System löschen und eine neue Installation über den Befehl jinstall innerhalb der Joomla-Installation starten. Man kann auch den Befehl jclean verwenden, um zu einem Joomla 3.x Branch zurückzuwechseln

Die etwas längere Startanleitung

Joomla ähnelt vielen anderen Web-Tools dieser Tage. Es hat einen großen PHP-Anteil und es hat mehr und mehr JavaScript-Code. Während die PHP-Codierung nicht so viel Vorbereitung benötigt, muss man bei JavaScript eine Menge Tools verwenden. Der Hauptgrund ist, dass niemand Code so schreibt, dass ihn jeder Browser versteht, also muss der Code z.B. von ES6 in eine kompatible Version von JavaScript umgesetzt werden. Das Gleiche gilt für CSS. Für Joomla verwenden wir SASS und das wird in natives CSS umgewandelt, sodass jeder Browser es versteht. Auf der anderen Seite ist das Einrichten einer Entwicklungsumgebung etwas komplizierter, aber das Instrumentarium macht das Programmieren bequemer. Dank der Wächter und dem automatischen Reload des Browsers, können Änderungen in Echtzeit verfolgt werden.

PHP

Es sollte reichen, composer install auszuführen. Dies wird die PHP-Abhängigkeiten, die in der Datei composer.lock gespeichert sind, installieren. Man kann dies beliebig oft wiederholen, es werden nur neue Pakete installiert, wenn die composer.lock Datei verändert wird. Bitte composer update nicht ausführen, da dadurch alle Pakete auf neuere Versionen und die composer.lock Datei aktualisiert werden.

Hinweis: Möglicherweise muss composer install mit der Option --ignore-platform-reqs ausgeführt werden, um die in Composer angegebenen Plattformanforderungen zu ignorieren. Das gilt, falls die PHP-LDAP-Erweiterung nicht installiert ist.

Node/npm Skripte

Node.js wird mit dem Paketmanager „NPM“ ausgeliefert (gewissermaßen vergleichbar zu Composer). NPM hat einen run-Befehl und wir haben einige Skripte vorbereitet, um die Arbeit zu erleichtern. Die Befehle müssen im Stammverzeichnis des Repositorys ausgeführt werden, sobald JS- oder SASS-Dateien geändert wurden. Zuvor muss man einmalig npm ci ausführen, um die Abhängigkeiten zu installieren.

npm run build:css

Kompiliert SASS Dateien nach CSS und erzeugt die komprimierten Dateien.

npm run build:js

Es kompiliert und übersetzt die JavaScript-Dateien in das richtige Format und erstellt sogenannte Minified-Dateien.

npm run watch

Dieser Befehl entspricht dem Befehl build:js, erkennt jedoch Änderungen und erstellt automatisch aktualisierte Dateien im Medienverzeichnis. SASS-Dateien sind noch nicht enthalten.

npm run lint:js

Damit wird eine Syntaxprüfung aller ES6-JavaScript-Dateien gegen den JavaScript-Codestandard durchgeführt (für weitere Informationen zum Joomla 4-Codestandard, bitte das Codestandard-Handbuch lesen).

npm run test

Dies wird eine JavaScript Testsuite ausführen.

Mögliche Probleme

Beim Installieren des Composers kann es zu folgenden Fehlern kommen:

Problem 1
    - Installation request for joomla/ldap 2.0.0-beta -> satisfiable by joomla/ldap[2.0.0-beta].
    - joomla/ldap 2.0.0-beta requires ext-ldap * -> the requested PHP extension ldap is missing from your system.
Problem 2
    - Installation request for symfony/ldap v5.1.5 -> satisfiable by symfony/ldap[v5.1.5].
    - symfony/ldap v5.1.5 requires ext-ldap * -> the requested PHP extension ldap is missing from your system.

Die Lösung ist, die Composer-Installation mit der Option --ignore-platform-reqs auszuführen, um die in Composer angegebenen Plattformanforderungen zu ignorieren. Das heißt, wenn die LDAP-Erweiterung von PHP nicht installiert ist.

composer install --ignore-platform-reqs

Wenn ein Anmeldefehler, wie unten abgebildet, angezeigt wird, sollte die Datei administrator/cache/autoload_psr4.php, wie im zweiten Bild gezeigt, gelöscht werden.

@@ Line 3: / Line 3: @@
 <noinclude>{{Joomla version|version=4.x}}</noinclude>
 {{-}}
-Mit Joomla! 4 wurde der Entwicklungsprozess verändert. Es ist nicht länger möglich, die Paketquelle zu klonen und damit Joomla! zu installieren. Im Folgenden ist nach aktuellen Erfahrungswerten ein funktionaler Weg zur Installation beschrieben.
+Mit Joomla! 4 wurde der Entwicklungsprozess verändert. Es ist nicht länger möglich, das Repository zu klonen und so Joomla! zu installieren. Im Folgenden ist nach aktuellen Erfahrungswerten ein funktionaler Weg zur Installation beschrieben.
 ==Schnellstart-Anweisungen==
 Abhängig vom Betriebssystem unterscheidet sich die Einrichtung der Entwicklungsumgebung. Es ist leider nicht möglich, den Vorgang für die verschiedenen Betriebssysteme zu dokumentieren. Die bevorzugte Suchmaschine wird hier weiterhelfen.
 === Benötigte Werkzeuge===
 # PHP - im Wesentlichen dasselbe wie beim Betreiben einer Joomla!-Seite, allerdings brauchst du eine spezielle Version, die PHP CLI (Kommandozeileneingabe) (beachte auch die Seite [[S:MyLanguage/Configuring_a_LAMPP_server_for_PHP_development|Einrichten eines LAMPP-Servers für die PHP-Entwicklung]])
 # Composer - um die Abhängigkeiten von Joomla!s PHP zu verwalten. Hilfe bei der Installation von Composer bietet die Dokumentation auf https://getcomposer.org/doc/00-intro.md
-# <span class="mw-translate-fuzzy">Node.js - um JavaScript- und SASS-Dateien für Joomla! zu kompilieren - Hilfe bei der Installation von Node.js bieten die Anweisungen, die auf https://nodejs.org/en/ erhältlich sind.</span>
+# Node.js - um JavaScript- und SASS-Dateien für Joomla! zu kompilieren - Hilfe bei der Installation von Node.js bieten die Anweisungen, die auf https://nodejs.org/en/ erhältlich sind. Hinweis: Für die Installation von Joomla wird mindestens NodeJS 12 benötigt.
 # Git - für die Versionsverwaltung.
 ===Schritt für Schritt zur Installation der lokalen Entwicklungsumgebung===
-# Klone die Paketquelle.
+# Das Repository klonen
-# Führe <tt>composer install</tt> im Wurzelverzeichnis der git-Paketquelle aus (du kannst --ignore-platform-reqs hinzufügen, falls du PHP-LDAP lokal nicht installiert hast und du es nicht brauchst)
+# <span class="mw-translate-fuzzy">Zum Branch der aktuellen Version wechseln (derzeit ''4.3-dev'')</span>
-# Führe <tt>npm ci</tt> im Wurzelverzeichnis der git-Paketquelle aus. (Dafür wird npm 5.7 oder höher benötigt. <tt>npm install -g npm@lts</tt> zum Aktualisieren der npm-Version auf lts ausführen.)
+# Die Installation von <tt>composer install</tt> im Stammverzeichnis des Git-Repositorys ausführen. (Man kann ''--ignore-platform-reqs'' hinzufügen, wenn man das PHP-LDAP nicht lokal installiert hat und es nicht benötigt.)
+# <span class="mw-translate-fuzzy">Im Stammverzeichnis des Git-Repositorys <tt>npm ci</tt> ausführen. (Bitte beachten, dass dafür npm 6.13.4 oder höher benötigt wird. Um die npm-Version auf die LTS-Version zu aktualisieren, sollte <tt>npm install -g npm@lts</tt> ausgeführt werden. Für Joomla 5 wird npm 10.1.0 oder höher benötigt. '''Tipp:''' Mit nvm (Node Version Manager) kann man leicht zu anderen npm-Versionen wechseln).</span>
 Linux und OSX Benutzer können den folgenden Bash-Alias nutzen und ihn in der ''~/.bashrc''-Datei setzen:
-<source lang="bash">
+<syntaxhighlight lang="bash">
-alias jclean="rm -rf administrator/templates/atum/css; rm -rf templates/cassiopeia/css; rm -rf media/; rm -rf node_modules/; rm -rf libraries/vendor/;rm -f administrator/cache/autoload_psr4.php;rm -rf installation/template/css"
+alias jclean="rm -rf administrator/templates/atum/css; \
+rm -rf templates/cassiopeia/css; \
+rm -rf administrator/templates/system/css; \
+rm -rf templates/system/css; \
+rm -rf media/; \
+rm -rf node_modules/; \
+rm -rf libraries/vendor/; \
+rm -f administrator/cache/autoload_psr4.php; \
+rm -rf installation/template/css"
 alias jinstall="jclean; composer install; npm ci"
-</source>
+</syntaxhighlight>
+Das wird alle kompilierten Dateien im System löschen und eine neue Installation über den Befehl <tt>jinstall</tt> innerhalb der Joomla-Installation starten. Man kann auch den Befehl <tt>jclean</tt> verwenden, um zu einem Joomla 3.x Branch zurückzuwechseln
-Dies wird alle kompilierten Dateien in deinem System löschen und gleichzeitig innerhalb deiner Joomla-Installation eine frische Installation über Kommando <tt>jinstall</tt> installieren. Du kannst auch den Befehl <tt>jclean</tt> verwenden, um zurück zu einer Joomla 3.x-Branch zu wechseln.
 ==Die etwas längere Startanleitung==
-Joomla! unterscheidet sich heutzutage nicht von anderen Internetwerkzeugen. Es weist einen großen PHP-Teil auf und erhält mehr und mehr JavaScript-Code. Während die Programmierung mit PHP nicht sehr viel Vorbereitung benötigt, braucht JavaScript eine umfangreiche Werkzeugumgebung. Der Hauptgrund liegt darin, dass niemand Programmkode auf eine Weise schreibt, die jeder Browser versteht, daher muss der Kode auch von zum Beispiel ES6 in eine kompatible Version von JavaScript transkompiliert werden. Dasselbe gilt für CSS: In Joomla! verwenden wir SASS, dieses wird in natives CSS konvertiert, sodass es jeder Browser verstehen kann. Die Kehrseite bei der Installation einer Entwicklerumgebung ist, dass es ein bisschen komplizierter ist, dafür die Werkzeugausstattung das Programmieren viel bequemer macht. Dank Wächtern und dem automatischen Browserreload werden Änderungen in Echtzeit angezeigt.
+Joomla ähnelt vielen anderen Web-Tools dieser Tage. Es hat einen großen PHP-Anteil und es hat mehr und mehr JavaScript-Code. Während die PHP-Codierung nicht so viel Vorbereitung benötigt, muss man bei JavaScript eine Menge Tools verwenden. Der Hauptgrund ist, dass niemand Code so schreibt, dass ihn jeder Browser versteht, also muss der Code z.B. von ES6 in eine kompatible Version von JavaScript umgesetzt werden. Das Gleiche gilt für CSS. Für Joomla verwenden wir SASS und das wird in natives CSS umgewandelt, sodass jeder Browser es versteht. Auf der anderen Seite ist das Einrichten einer Entwicklungsumgebung etwas komplizierter, aber das Instrumentarium macht das Programmieren bequemer. Dank der Wächter und dem automatischen Reload des Browsers, können Änderungen in Echtzeit verfolgt werden.
 === PHP ===
 Es sollte reichen, <tt>composer install</tt> auszuführen. Dies wird die PHP-Abhängigkeiten, die in der Datei composer.lock gespeichert sind, installieren. Man kann dies beliebig oft wiederholen, es werden nur neue Pakete installiert, wenn die composer.lock Datei verändert wird. Bitte <tt>composer update</tt> nicht ausführen, da dadurch alle Pakete auf neuere Versionen und die composer.lock Datei aktualisiert werden.
-Beachte: Eventuell muss <tt>composer install</tt> mit der Option <tt>--ignore-platform-reqs</tt> ausgeführt werden um Plattformanforderungen, die in Composer näher spezifiziert sind, zu ignorieren, dass heißt falls du die PHP LDAP Erweiterung nicht installiert hast.
+'''Hinweis:''' Möglicherweise muss <tt>composer install</tt> mit der Option <tt>--ignore-platform-reqs</tt> ausgeführt werden, um die in Composer angegebenen Plattformanforderungen zu ignorieren. Das gilt, falls die PHP-LDAP-Erweiterung nicht installiert ist.
 ===Node/npm Skripte===
-Node.js wird mit einem Paketmanager names NPM (in gewisser Weise das Gleiche wie Composer) ausgeliefert. NPM hat einen <tt>run</tt>-Befehl und wir haben ein paar Skripte vorbereitet, die dir das Leben erleichtern. Man muss die Befehle im Stammverzeichnis der Paketquellen ausführen.
+Node.js wird mit dem Paketmanager „NPM“ ausgeliefert (gewissermaßen vergleichbar zu Composer). NPM hat einen <tt>run</tt>-Befehl und wir haben einige Skripte vorbereitet, um die Arbeit zu erleichtern. Die Befehle müssen im Stammverzeichnis des Repositorys ausgeführt werden, sobald JS- oder SASS-Dateien geändert wurden. Zuvor muss man einmalig <tt>npm ci</tt> ausführen, um die Abhängigkeiten zu installieren.
 ====npm run build:css====
@@ Line 43: / Line 53: @@
 ==== npm run build:js ====
-Kompiliert und transkompiliert die JavaScript Dateien in das richtige Format und erzeugt verkleinerte Dateien.
+Es kompiliert und übersetzt die JavaScript-Dateien in das richtige Format und erstellt sogenannte Minified-Dateien.
-==== npm run watch:css ====
+==== npm run watch ====
-Führt auch den Befehl <tt>build:css</tt> aus, bemerkt aber Veränderungen und erstellt automatisch aktualisierte Dateien.
+Dieser Befehl entspricht dem Befehl <tt>build:js</tt>, erkennt jedoch Änderungen und erstellt automatisch aktualisierte Dateien im Medienverzeichnis. SASS-Dateien sind noch nicht enthalten.
-====npm run watch:js====
-Dies ist das Gleiche wie der <tt>build:js</tt>-Befehl, sucht aber Veränderungen und erstellt automatisch aktualisierte Dateien.
 ==== npm run lint:js ====
-Führt eine Syntaxprüfung in den JavaScript-Dateien aus.
+Damit wird eine Syntaxprüfung aller ES6-JavaScript-Dateien gegen den JavaScript-Codestandard durchgeführt (für weitere Informationen zum Joomla 4-Codestandard, bitte das [https://developer.joomla.org/coding-standards/introduction.html| Codestandard-Handbuch] lesen).
 ==== npm run test ====
-Dies wird andere JavaScript Testsuiten ausführen.
+Dies wird eine JavaScript Testsuite ausführen.
 ==Mögliche Probleme==
-When running composer install you can run into these errors
+Beim Installieren des Composers kann es zu folgenden Fehlern kommen:
-<source lang="bash">
+<syntaxhighlight lang="bash">
 Problem 1
      - Installation request for joomla/ldap 2.0.0-beta -> satisfiable by joomla/ldap[2.0.0-beta].
@@ Line 67: / Line 74: @@
      - Installation request for symfony/ldap v5.1.5 -> satisfiable by symfony/ldap[v5.1.5].
      - symfony/ldap v5.1.5 requires ext-ldap * -> the requested PHP extension ldap is missing from your system.
-</source>
+</syntaxhighlight>
+Die Lösung ist, die Composer-Installation mit der Option <tt>--ignore-platform-reqs</tt> auszuführen, um die in Composer angegebenen Plattformanforderungen zu ignorieren. Das heißt, wenn die LDAP-Erweiterung von PHP nicht installiert ist.
-The solution is to run the composer install with the <tt>--ignore-platform-reqs</tt> option to ignore platform requirements specified in Composer. That is, if you do not have PHP's LDAP extension installed.
+<syntaxhighlight lang="bash">composer install --ignore-platform-reqs</syntaxhighlight>
-<source lang="bash">composer install --ignore-platform-reqs</source>
+Wenn ein Anmeldefehler, wie unten abgebildet, angezeigt wird, sollte die Datei <tt>administrator/cache/autoload_psr4.php</tt>, wie im zweiten Bild gezeigt, gelöscht werden.
-Solltest du einen Fehler beim Einloggen wie im Beispiel unten erhalten, dann lösche die Datei <tt>\library\autoload_psr4.php</tt> wie im zweiten Bild zu sehen ist.
+[[File:Install-error.png|border|center|400px|Login After Install Error]]
-[[File:Install-error.png|400px|Login After Install Error]]
-[[File:Psr4.png|400px|autoload_psr4.php]]
 <noinclude>

J4.x