ctdo
/
homepage
10
0
Fork 0
Code Issues 10 Pull Requests Releases Wiki Activity

add instructions for developing

This commit is contained in:
neri 2019-12-17 22:12:50 +01:00
parent bd8fa6d1d7
commit 170fbbe0d2
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,5 +1,15 @@
# Ctdo Homepage # 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 ## Eine Seite bearbeiten
Klicke bei der Seite, die du bearbeiten möchtest unten im Footer auf "Seite bearbeiten". Klicke bei der Seite, die du bearbeiten möchtest unten im Footer auf "Seite bearbeiten".
@ -21,6 +31,7 @@ ein.
## Seitenlayout ## Seitenlayout
Eine Seite muss mit folgendem Header beginnen: Eine Seite muss mit folgendem Header beginnen:
``` ```
--- ---
path: "" path: ""
@ -28,6 +39,7 @@ title: ""
edit: "" edit: ""
--- ---
``` ```
In `path` muss stehen, unter welchem Pfad die Seite auf der Webseite erscheint. 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". 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. 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. klicke auf Commit und gib eine Beschreibung deiner Änderungen ein.
Ungefähr 30 Sekunden später sollten deine Änderungen auf der Website sichtbar sein. 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. Möglicherweise musst du einmal mit Shift+F5 deinen Browsercache ignorieren.