Skip to content

Starterkit based on Parcel for the Students of the Seminar GT 1191.

Notifications You must be signed in to change notification settings

HAWK-GT1191/gt1191-starterkit

Repository files navigation

GT 1191 Starterkit

Mit diesem Starterkit des Seminars GT 1191 der Hochschule für angewandte Wissenschaft und Kunst (HAWK) kannst du im Handumdrehen neue Websites entwickeln.

Das Starterkit nutzt das Build-Tool Parcel und ist vorkonfiguriert mit CSS Nesting und Custom media queries sowie PostHTML für die Erstellung von reponsiven Single- und Multi-Page-Websites.

Build CI

Voraussetzungen

Um mit dem Starterkit arbeiten zu können, musst du vorab Git und die Paketmanager Node.js und Yarn auf deinem Computer installieren:

Zur Installationsanleitung

Neue Website anlegen

Lade dir die Dateien des Starterkits herunter und lege sie in dem Verzeichnis deiner neuen Website ab.

# Speichert die Dateien im aktuellen Verzeichnis
$ git clone --depth 1 https://github.com/HAWK-GT1191/gt1191-starterkit.git .

# Speichert die Dateien in einem neuen Verzeichnis
$ git clone --depth 1 https://github.com/HAWK-GT1191/gt1191-starterkit.git neue-website

Installiere nun die Abhängigkeiten des Starterkits:

$ yarn install

Sollte die Installation fehlschlagen, lösche bitte das Verzeichnis node_modules und yarn.lock und starte die Installation erneut.

Entwicklung

Ist das Starterkit eingerichtet, kannst du mit der Entwicklung deiner Website anfangen. Der folgende Befehl startet einen Webserver, erstellt einen „Build“ deiner Website im Verzeichnis dist, öffnet diesen im Browser und zeigt Datenänderungen ohne Reload an:

$ yarn dev

Lässt sich das Starterkit im Fehlerfall – zum Beispiel nach dem Kopieren – nicht starten, gebe einmalig yarn clean in das Terminal ein.

Datei- und Verzeichnisstruktur

Folgende Verzeichnisse sind dabei zu beachten.

  • src
    Das ist dein Arbeitsverzeichnis und enthält die das Template der Startseite index.html, sowie deine Unterseiten. Portfolio ist als Beispiel eingebunden.
  • src/snippets
    enthält die HTML-Snippets (Codeschnipsel), die du mittels <include> in deine Website einbinden kannst. Praktisch für den Header oder Footer deiner Website, wenn du diese auf jeder Unterseite wiederverwenden möchtest.
  • src/styles
    enthält die Stylesheet-Datei main.css, in der alle anderen CSS-Dateien zur besseren Organistation importiert werden. Daraus entsteht am Ende eine große CSS-Datei. Alle Vorgabgen darfst (und solltest) du gern anpassen oder ganz löschen.
  • src/images
    enthält ein paar Beispielbilder (u. a. von Unsplash). Diese sind bereits in die Website eingebunden, damit du sehen kannst, wie das funktioniert.

Verwendung von Bildern

Das Starterkit unterstützt von Haus aus die Einbindung und Optimierung von Bildern. Nutze dazu bitte dafür die Beispiele und lese dir die Image-Dokumentation durch.

Vorsicht: Das Beispiel ist nicht responsiv oder mobil-optimiert. Es zeigt dir aber, wie du verschiedene Bildformate nutzen kannst.

Website veröffentlichen/versenden

Wenn du deine Website auf deinem eigenen Webserver veröffentlichen möchtest, muss diese einmal „gebacken” (build) werden. Folgender Befehl startet den Build-Prozess und legt das Ergebnis einer statischen Website im Verzeichnis dist ab. Dessen Inhalt kannst du dann mit FTP oder SSH auf deinen Webserver hochladen.

$ yarn build

Möchtest du deine Website zur Bewertung oder Benotung abgeben, verwende folgenden Befehl, um die Dateigröße vor dem zippen zu minimieren.

$ yarn deliver

Mit yarn install kannst du anschließend wieder weiterarbeiten.