From fc710a11b1d16eab9cbb910aaa0d2ad7fe7748a3 Mon Sep 17 00:00:00 2001 From: Holger Trampe Date: Tue, 18 May 2021 20:57:42 +0000 Subject: [PATCH] =?UTF-8?q?=E2=80=9EREADME.md=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 65 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 34 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index de5e1e4..3a062a8 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,46 @@ -# Module Agency +# Nextcloud Vue.js Template Placeholder +Dies ist eine Vorlage, um neue Module für die DA im Rahmen von Nextcloud mit Vue.js zu implementieren. -## Was zu ändern ist +## Dateien zum ändern +Folgende Dateien müssen mit dem neuen Modulnamen abgeändert werden. -Änderungen bei einem neuen Modul +### appinfo +* info.xml + * id, name, summary, namespace, category, navigation (name, route, icon) +* routes.php + * Eventuell hier anpassen, aber das erstmal so lassen -appinfo -> - info.xml - - id, name, summary, namespace, category, navigation (name, route, icon) - routes.php - - Eventuell hier anpassen, aber das erstmal so lassen +### js +* Dieser Ordner sollte leer sein. Hier kommen später durch *make build-js* bzw. für den HotReload *make watch-js* gefüllt. -js -> - Dieser Ordner sollte LEER sein +### lib -> Controller +* PageController.php + * namespace (Zeile 4), + * Zeile 25 bei main den neuen Modulnamen davorschreiben -lib -> Controller -> - PageController.php - - namespace (Zeile 4), - - Zeile 25 bei main den neuen Modulnamen davorschreiben -src -> - App.vue - - bei Content den app-name ändern, NICHT aber weiter unten bei export default usw. +### src +* App.vue + * bei Content den app-name ändern, NICHT aber weiter unten bei export default usw. -README.md - Hier einmal als Kommentar den Modulnamen anpassen fürs Git -composer.json - bei name anpassen auf da/NAMEDESMODULS - description anpassen -package.json - name und desc anpassen sowie version und author +### README.md +* Hier einmal als Kommentar den Modulnamen anpassen fürs Git -Befehl für den Docker und die Bash, um die Befehle beim Docker abzusetzen -docker exec -it nextcloud bash +### composer.json +* Bei *name* anpassen auf da/NAME_DES_MODULS +* description anpassen +* package.json + * name und desc anpassen sowie version und author -hier dann ins Verzeichnis, dann: -npm install +## Befehle und Hinweise +Folgender Befehl wird benötigt, um auf dem entsprechenden Docker die Bash zu starten: +**docker exec -it nextcloud bash** + +Im Verzeichnis dann die Dependencies installieren: +**npm install** Das dauert dann kurz, weil ja alle node_modules installiert und eingerichtet werden. -dann für HOT REALOAD: make watch-js -oder für BUILD: make build-js --> Die Skripte sind in der package.json verlinkt +Dann für HOT REALOAD: *make watch-js* +oder für BUILD: *make build-js* +Die Skripte sind in der package.json verlinkt