Taskx mittels Laraknife: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
(35 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
Zeile 2: | Zeile 2: | ||
* [[Laraknife]] | * [[Laraknife]] | ||
* [[Laravel]] | * [[Laravel]] | ||
* [[LaraKnife Kochbuch]] | |||
* [[Deployment Laraknife Projekt]] | |||
= Zielsetzung = | = Zielsetzung = | ||
Zeile 15: | Zeile 17: | ||
= Installation = | = Installation = | ||
* php muss installiert sein! [[PHP einrichten]] php-sqlite3 | |||
* mariadb muss installiert sein: [[mysql]] | |||
* als normaler Benutzer (nicht root): | * als normaler Benutzer (nicht root): | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
SCRIPT=/tmp/CreateLaraProj.sh | PROJ=taskx | ||
SCRIPT=/var/tmp/CreateLaraProj.sh | |||
wget "https://public.hamatoma.de/public/CreateLaraProj.sh" -O $SCRIPT | wget "https://public.hamatoma.de/public/CreateLaraProj.sh" -O $SCRIPT | ||
chmod +x $SCRIPT | chmod +x $SCRIPT | ||
PASSW=topsecret | PASSW=topsecret | ||
BASE=/home/ws/php | BASE=/home/ws/php | ||
sudo apt update | |||
sudo apt install composer -y | |||
$SCRIPT $PROJ "$PASSW" "$BASE" | $SCRIPT $PROJ "$PASSW" "$BASE" | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Am Ende wird dazu aufgefordert, das Script /tmp/IncludeLara.sh zu starten: | * Am Ende wird dazu aufgefordert, das Script /tmp/IncludeLara.sh zu starten: | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
/tmp/IncludeLara.sh | # wget https://public.hamatoma.de/public/IncludeLara.sh -O /tmp/IncludeLara.sh | ||
# chmod +x /tmp/IncludeLara.sh | |||
/tmp/IncludeLara.sh $BASE/$PROJ local | |||
# oder | |||
/tmp/IncludeLara.sh $BASE/$PROJ git | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Zeile 34: | Zeile 46: | ||
cd $BASE/$PROJ | cd $BASE/$PROJ | ||
larascripts/laraknife-tool.sh rest | larascripts/laraknife-tool.sh rest | ||
./Own.sh all | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Das folgende sind die einzelnen Schritte, '''normalerweise''' | Das folgende sind die einzelnen Schritte, '''normalerweise nicht''' erforderlich: | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
# Links erstellen/auffrischen: | |||
larascripts/laraknife-tool.sh build-links [--force] | |||
# Mehrsprachigkeit | # Mehrsprachigkeit | ||
larascripts/laraknife-tool.sh init-i18n | larascripts/laraknife-tool.sh init-i18n | ||
Zeile 52: | Zeile 68: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
= Modul | = Entwicklungsumgebung starten = | ||
<syntaxhighlight lang="bash"> | |||
cd /home/ws/php/taskx | |||
./Build | |||
# In einem ANDEREN Terminal: | |||
php artisan serve | |||
</syntaxhighlight> | |||
= Modul Device erstellen = | |||
== Tabellenbeschreibung erstellen == | == Tabellenbeschreibung erstellen == | ||
* Konvention: Tabelle wird kleingeschrieben, im Plural | * Konvention: Tabelle wird kleingeschrieben, im Plural | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
TABLE= | TABLE=devices | ||
php artisan make:migration create_${TABLE}_table | php artisan make:migration create_${TABLE}_table | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Es wird die Datei database/migrations/ | * Es wird die Datei database/migrations/2023_12_29_180821_create_devices_table.php erzeugt, wobei Datum/Uhrzeit bei jeder Generierung anders ist. | ||
* Diese Datei anpassen: | * Diese Datei anpassen: | ||
<pre> | <pre> | ||
Schema::create(' | Schema::create('devices', function (Blueprint $table) { | ||
$table->id(); | $table->id(); | ||
$table->timestamps(); | $table->timestamps(); | ||
$table->string(' | $table->string('name'); | ||
$table->text(' | $table->text('description'); | ||
$table->integer('devicegroup_scope'); | |||
$table->integer(' | $table->foreignId('owner_id')->nullable()->references('id')->on('users'); | ||
$table-> | |||
}); | }); | ||
} | } | ||
</pre> | </pre> | ||
* Syntax für Feldänderungen: [[Datenbank-Laravel#Feld%C3%A4nderungen]] | |||
== Modul erzeugen == | == Modul erzeugen == | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
php artisan migrate | php artisan migrate | ||
./Lara create:module database/migrations/*_create_${TABLE}_table.php | ./Lara create:module database/migrations/*_create_${TABLE}_table.php | ||
# oder, wenn das Modul nicht automatisch gebildet werden kann: | |||
./Lara create:module database/migrations/*_create_${TABLE}_table.php --module=device | |||
php artisan migrate | |||
</syntaxhighlight> | |||
== Database Seeder == | |||
Um Tabellen mit sinnvollen Daten vorzubelegen, werden '''Database Seeder''' verwendet. | |||
<syntaxhighlight lang="bash"> | |||
php artisan make:seeder DeviceSeeder | |||
</syntaxhighlight> | |||
Die entstehende Datei database/seeders/DeviceSeeder.php anpassen: Icons in https://icons.getbootstrap.com | |||
<pre> | |||
public function run(): void | |||
{ | |||
SProperty::insertIfNotExists(2001, 'devicegroup', 'Computer', 10, 'C'); | |||
SProperty::insertIfNotExists(2002, 'devicegroup', 'Router', 20, '$'); | |||
Menuitem::insertIfNotExists('articles', 'bi bi-journals'); | |||
Module::insertIfNotExists('Article'); | |||
} | |||
</pre> | |||
Aktivieren: | |||
<syntaxhighlight lang="bash"> | |||
php artisan db:seed --class=DeviceSeeder | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Zeile 86: | Zeile 134: | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
... | ... | ||
DeviceController::routes(); | |||
... | ... | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Zeile 102: | Zeile 150: | ||
* Felder ausfüllen | * Felder ausfüllen | ||
* Oben rechts: Login | * Oben rechts: Login | ||
== In Homepage einfügen == | |||
* resources/views/home.blade.php: | |||
<pre> | |||
<li><a href="/device-index">Geräte</a></li> | |||
</pre> | |||
== Controller und Views anpassen == | == Controller und Views anpassen == | ||
=== Übersicht (index) === | === Übersicht (index) === | ||
* Datei app/Http/Controllers/ | * Datei app/Http/Controllers/DeviceController.php | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
public function index() | public function index() | ||
{ | { | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Datei resources/views/ | * Datei resources/views/device/index.blade.php | ||
<syntaxhighlight lang="html"> | <syntaxhighlight lang="html"> | ||
<form id=" | <form id="device-index" action="/device-index" method="POST"> | ||
@csrf | @csrf | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== Anlegen (create) === | === Anlegen (create) === | ||
* Datei app/Http/Controllers/ | * Datei app/Http/Controllers/DeviceController.php | ||
* Die drei Methoden '''ersetzen''': | * Die drei Methoden '''ersetzen''': | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Datei resources/views/ | * Datei resources/views/device/create.blade.php | ||
<syntaxhighlight lang="html"> | <syntaxhighlight lang="html"> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Übersetzungen in resources/lang/sources/taskx.de.json | * Übersetzungen in resources/lang/sources/taskx.de.json | ||
<pre> | <pre> | ||
" | "Devices": "Geräte", | ||
</pre> | </pre> | ||
* Aktivieren: | * Aktivieren: | ||
Zeile 265: | Zeile 190: | ||
=== Ändern (edit) === | === Ändern (edit) === | ||
* Datei app/Http/Controllers/ | * Datei app/Http/Controllers/DeviceController.php | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
public function edit( | public function edit(Device $device) | ||
{ | { | ||
} | } | ||
public function update( | public function update(Device $device, Request $request) | ||
{ | { | ||
$rc = null; | $rc = null; | ||
return $rc; | return $rc; | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Datei resources/views/ | * Datei resources/views/device/edit.blade.php | ||
<syntaxhighlight lang="html"> | <syntaxhighlight lang="html"> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Übersetzungen in resources/lang/sources/taskx.de.json | * Übersetzungen in resources/lang/sources/taskx.de.json | ||
<pre> | <pre> | ||
"Change of a | "Change of a Device": "Ändern eines Gerätes", | ||
</pre> | </pre> | ||
* Aktivieren: | * Aktivieren: | ||
Zeile 329: | Zeile 216: | ||
=== Anzeigen (show/delete) === | === Anzeigen (show/delete) === | ||
* Datei app/Http/Controllers/ | * Datei app/Http/Controllers/DeviceController.php | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
public function show( | public function show(Device $device) | ||
{ | { | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Datei resources/views/ | * Datei resources/views/device/show.blade.php | ||
<syntaxhighlight lang="html"> | <syntaxhighlight lang="html"> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Übersetzungen in resources/lang/sources/taskx.de.json | * Übersetzungen in resources/lang/sources/taskx.de.json | ||
<pre> | <pre> | ||
"A | "A Device" : "Ein Gerät", | ||
"Deletion of a | "Deletion of a Device": "Löschen eines Gerätes", | ||
</pre> | </pre> | ||
* Aktivieren: | * Aktivieren: | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
./Join | ./Join | ||
</syntaxhighlight> | |||
= Neue Instanz von taskx einrichten = | |||
* Lokal: | |||
<syntaxhighlight lang="bash"> | |||
PROJ=taskx | |||
BASE=/home/ws/php | |||
cd $BASE | |||
git clone ssh://git@git.hamatoma.de:/home/git/repo/$PROJ.git | |||
cd $PROJ | |||
scripts/InitApp.sh | |||
</syntaxhighlight> | |||
* auf einem Server: | |||
<syntaxhighlight lang="bash"> | |||
PROJ=taskx | |||
DOMAIN=$PROJ.hamatoma.de | |||
BASE=/srv/www | |||
cd $BASE | |||
sudo -u www-data git config --global --add safe.directory /home/git/repo/$PROJ.git | |||
sudo -u www-data git clone /home/git/repo/$PROJ.git | |||
mv $PROJ $DOMAIN | |||
cd $DOMAIN | |||
sudo -u www-data git checkout main | |||
../laraknife/scripts/InstallInitApp.sh | |||
echo "DEV_USER=www-data" >.env.user | |||
./Own.sh all | |||
cp .env.example .env | |||
vi .env | |||
bash scripts/InitApp.sh | |||
sudo -u www-data ./Build prod | |||
sudo -u www-data ./artisan key:generate | |||
</syntaxhighlight> | </syntaxhighlight> |
Aktuelle Version vom 3. Januar 2025, 21:21 Uhr
Links
Zielsetzung
Es soll eine minimale Web-Applikation mit den Werkzeugen Laravel und Laraknife erstellt werden: Eine Verwaltung von Notizen.
Name
Eine Verballhornung des Wortes "Tasks": Die schwäbische Aussprache spricht ein x am Ende.
Eigenschaften
- Benutzerverwaltung: nur angemeldete Benutzer können Applikation nutzen
- Rechteverwaltung mittels Rollen
- Verwaltung von Notizen: Titel, Text, Kategorie, Status: offen, erledigt
Installation
- php muss installiert sein! PHP einrichten php-sqlite3
- mariadb muss installiert sein: mysql
- als normaler Benutzer (nicht root):
PROJ=taskx
SCRIPT=/var/tmp/CreateLaraProj.sh
wget "https://public.hamatoma.de/public/CreateLaraProj.sh" -O $SCRIPT
chmod +x $SCRIPT
PASSW=topsecret
BASE=/home/ws/php
sudo apt update
sudo apt install composer -y
$SCRIPT $PROJ "$PASSW" "$BASE"
- Am Ende wird dazu aufgefordert, das Script /tmp/IncludeLara.sh zu starten:
# wget https://public.hamatoma.de/public/IncludeLara.sh -O /tmp/IncludeLara.sh
# chmod +x /tmp/IncludeLara.sh
/tmp/IncludeLara.sh $BASE/$PROJ local
# oder
/tmp/IncludeLara.sh $BASE/$PROJ git
Restliche Installation
cd $BASE/$PROJ
larascripts/laraknife-tool.sh rest
./Own.sh all
Das folgende sind die einzelnen Schritte, normalerweise nicht erforderlich:
# Links erstellen/auffrischen:
larascripts/laraknife-tool.sh build-links [--force]
# Mehrsprachigkeit
larascripts/laraknife-tool.sh init-i18n
# Die neuen Übersetzungen müssen in resources/lang/sources/taskx.de.json eingetragen werden.
# Roles und SProperties füllen
larascripts/laraknife-tool.sh fill-db
# Laraknife-Module anpassen
larascripts/laraknife-tool.sh adapt-modules
# Layout erstellen
larascripts/laraknife-tool.sh create-layout
# Homepage einrichten
larascripts/laraknife-tool.sh create-home
Entwicklungsumgebung starten
cd /home/ws/php/taskx
./Build
# In einem ANDEREN Terminal:
php artisan serve
Modul Device erstellen
Tabellenbeschreibung erstellen
- Konvention: Tabelle wird kleingeschrieben, im Plural
TABLE=devices
php artisan make:migration create_${TABLE}_table
- Es wird die Datei database/migrations/2023_12_29_180821_create_devices_table.php erzeugt, wobei Datum/Uhrzeit bei jeder Generierung anders ist.
- Diese Datei anpassen:
Schema::create('devices', function (Blueprint $table) { $table->id(); $table->timestamps(); $table->string('name'); $table->text('description'); $table->integer('devicegroup_scope'); $table->foreignId('owner_id')->nullable()->references('id')->on('users'); }); }
- Syntax für Feldänderungen: Datenbank-Laravel#Feldänderungen
Modul erzeugen
php artisan migrate
./Lara create:module database/migrations/*_create_${TABLE}_table.php
# oder, wenn das Modul nicht automatisch gebildet werden kann:
./Lara create:module database/migrations/*_create_${TABLE}_table.php --module=device
php artisan migrate
Database Seeder
Um Tabellen mit sinnvollen Daten vorzubelegen, werden Database Seeder verwendet.
php artisan make:seeder DeviceSeeder
Die entstehende Datei database/seeders/DeviceSeeder.php anpassen: Icons in https://icons.getbootstrap.com
public function run(): void { SProperty::insertIfNotExists(2001, 'devicegroup', 'Computer', 10, 'C'); SProperty::insertIfNotExists(2002, 'devicegroup', 'Router', 20, '$'); Menuitem::insertIfNotExists('articles', 'bi bi-journals'); Module::insertIfNotExists('Article'); }
Aktivieren:
php artisan db:seed --class=DeviceSeeder
Routing einrichten
- In Datei routes/web.php einfügen:
...
DeviceController::routes();
...
- Die Klasse NodeController ist unterstrichen: mit Strg-Alt-I Klassen einbinden.
Starten, Registrieren, Login
- Den Webserver starten:
./Build
# in einem anderen Terminal:
php artisan serve
- Im Brower aufrufen: http://localhost:8000
- Oben rechts: Register
- Felder ausfüllen
- Oben rechts: Login
In Homepage einfügen
- resources/views/home.blade.php:
<li><a href="/device-index">Geräte</a></li>
Controller und Views anpassen
Übersicht (index)
- Datei app/Http/Controllers/DeviceController.php
public function index()
{
}
- Datei resources/views/device/index.blade.php
<form id="device-index" action="/device-index" method="POST">
@csrf
Anlegen (create)
- Datei app/Http/Controllers/DeviceController.php
- Die drei Methoden ersetzen:
- Datei resources/views/device/create.blade.php
- Übersetzungen in resources/lang/sources/taskx.de.json
"Devices": "Geräte",
- Aktivieren:
./Join
Ändern (edit)
- Datei app/Http/Controllers/DeviceController.php
public function edit(Device $device)
{
}
public function update(Device $device, Request $request)
{
$rc = null;
return $rc;
}
- Datei resources/views/device/edit.blade.php
- Übersetzungen in resources/lang/sources/taskx.de.json
"Change of a Device": "Ändern eines Gerätes",
- Aktivieren:
./Join
Anzeigen (show/delete)
- Datei app/Http/Controllers/DeviceController.php
public function show(Device $device)
{
}
- Datei resources/views/device/show.blade.php
- Übersetzungen in resources/lang/sources/taskx.de.json
"A Device" : "Ein Gerät", "Deletion of a Device": "Löschen eines Gerätes",
- Aktivieren:
./Join
Neue Instanz von taskx einrichten
- Lokal:
PROJ=taskx
BASE=/home/ws/php
cd $BASE
git clone ssh://git@git.hamatoma.de:/home/git/repo/$PROJ.git
cd $PROJ
scripts/InitApp.sh
- auf einem Server:
PROJ=taskx
DOMAIN=$PROJ.hamatoma.de
BASE=/srv/www
cd $BASE
sudo -u www-data git config --global --add safe.directory /home/git/repo/$PROJ.git
sudo -u www-data git clone /home/git/repo/$PROJ.git
mv $PROJ $DOMAIN
cd $DOMAIN
sudo -u www-data git checkout main
../laraknife/scripts/InstallInitApp.sh
echo "DEV_USER=www-data" >.env.user
./Own.sh all
cp .env.example .env
vi .env
bash scripts/InitApp.sh
sudo -u www-data ./Build prod
sudo -u www-data ./artisan key:generate