From 170fbbe0d282e0f79a5aca2aa253672ab84f323c Mon Sep 17 00:00:00 2001 From: neri Date: Tue, 17 Dec 2019 22:12:50 +0100 Subject: [PATCH] add instructions for developing --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a083b3a..335b703 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ # Ctdo Homepage +## Selbst bauen + +Um das Projekt zu bauen, oder lokal daran zu entwickeln musst du `nodejs` und `yarn` installiert +haben. + +Um die Dependencies zu installieren führe einmal im Projektverzeichnis `yarn` aus. +Um die Webseite lokal zu testen führe danach `yarn develop` aus. +Für einen Produktivbuild `yarn build`. +Die fertig gebauten Dateien landen dann im Ordner `public`. + ## Eine Seite bearbeiten Klicke bei der Seite, die du bearbeiten möchtest unten im Footer auf "Seite bearbeiten". @@ -21,6 +31,7 @@ ein. ## Seitenlayout Eine Seite muss mit folgendem Header beginnen: + ``` --- path: "" @@ -28,6 +39,7 @@ title: "" edit: "" --- ``` + In `path` muss stehen, unter welchem Pfad die Seite auf der Webseite erscheint. Für die Home-Seite ist dies beispielsweise "/", für die "Zeiten & Location"-Seite "/treff". In `title` steht der Text der im Browsertab angezeigt werden soll wenn die Seite offen ist. @@ -43,4 +55,3 @@ Wenn du mit deinen Änderungen fertig bist, klicke auf Commit und gib eine Beschreibung deiner Änderungen ein. Ungefähr 30 Sekunden später sollten deine Änderungen auf der Website sichtbar sein. Möglicherweise musst du einmal mit Shift+F5 deinen Browsercache ignorieren. -