/semesterarbeit-sebi-roberto-2020

Primary LanguageJavaScript

Semesterarbeit

Digitaler Familienkalender

Einleitung

Diese Applikation soll es ermöglichen, online und somit unabhänging von einem physischen an nur einem Ort verfügbaren Familienkalender, Termine für jedes Familienmitglied zu erfassen. Die Applikation besteht aus zwei Node.js Projekten. Eines für den Applikationsserver im Backend und eines für das Frontend.

Vorbereitung und Applikationsstart

GIT Repository clonen oder ZIP download

Erstellung der benötigten Datenbank

Verwendung einer MariaDB oder MySQL Datenbank
Folgende Schritte müssen als root (oder als User mit entsprechenden Rechten) nach dem Einloggen in SQL ausgeführt werden:

  1. Erstellung einer Datenbank mit dem Namen calender
    Verwendeter Befehl im Terminal:
create database calender;
  1. Erstellen der Tabelle familycalender
    Zum Erstellen der benötigten Tabelle in der Datenbank, inkl. vorabgefüllter Daten zur Kalender-Demonstration, kann das File calender.sql, welches im src Verzeichnis zu finden ist, verwendet werden.
    Dazu, immer noch im Terminal der Datenbank, das .sql File mittels dem SOURCE Befehl importieren
SOURCE <Pfad zur Datei>

Projekt in IntelliJ öffnen

  1. Backend
    1a: Falls IntelliJ im Hauptverezeichnis fragt ob npm install ausgeführt werden soll, dies bestätigen.
    1b: Alternativ manuell im Terminal im Hauptverzeichnis den Befehl npm install ausführen
  2. Frontend
    2a: Falls IntelliJ im Verzeichnis calenderView fragt ob npm install ausgeführt werden soll, dies bestätigen.
    2b. Alternativ manuell im Terminal im Verzeichnis calenderView den Befehl npm install durchführen
  3. Im File ormconfig.json, zu finden im Hauptverzeichnis, den Usernamen und das Passwort für den Zugriff auf die Datenbank eintragen

Applikation starten

  1. Terminal im Hauptverzeichnis öffnen und das Backend mit dem Befehl npm run start ausführen
  2. Zweites Terminalfenster im Verzeichnis calenderView öffnen und das Frontend mit dem Befehl npm run start ausführen

-> Das Frontend kann nun im Browser unter http://localhost:1234 aufgerufen werden

TESTS

Unit-Tests

Für die Unit-Tests muss das Backend gestartet sein!

  • Um die Unit-Tests in der Konsole zu starten, im Terminal im Verzeichnis calenderView den Befehl npm run test ausführen.

End2End-Tests

Für die End2End-Tests müssen das Backend und das Frontend gestartet sein.

  • Um die End2End-Tests in der Konsole zu starten, im Terminal im Verzeichnis Hauptverzeichnis den Befehl npm run test:e2e ausführen.
  • Im geöffneten Browserfenster auf Run all specs klicken
  • alternativ auf calender.spec.js doppelklicken