Skip to content

Latest commit

 

History

History
189 lines (134 loc) · 13.8 KB

README.md

File metadata and controls

189 lines (134 loc) · 13.8 KB
Raw

99Deals

Überblick

99Deals ist eine aufregende und einzigartige E-Commerce Plattform. Jeden Tag werden vier spezielle Deals von vier verschiedenen Unternehmen angeboten, wobei jeder Deal auf nur 99 Stück limitiert ist. Die Plattform ist unkompliziert, neuzeitlich und bietet den Nutzern ein spannendes Einkaufserlebnis. Sie wurde mit Angular und Strapi als Headless CMS erstellt.

Übrigens

Im Laufe der Projektentwicklung sind wir auf  eine Herausforderung gestossen, als wir versuchten, Updates auf GitLab zu pushen. Dabei haben wir irrtümlich die Haupt-Branches überschrieben. Als Workaround und zur Wahrung der Arbeitskontinuität und -integrität, haben wir uns entschieden mehrere Branches anzulegen. Zusätzlich zum Entscheid ist die Tatsache dass der der Strapi-Server unabhängig heruntergeladen, abgespeichert und ausgeführt werden muss, um potenzielle Konflikte mit der Angular-Anwendung zu vermeiden und eine unabhängige Verwaltung der Backend-Ressourcen zu gewährleisten.

Installation und Start

Um mit Angular zu arbeiten, benötigen Sie die folgenden Tools:

  • Node.js: Angular erfordert eine aktuelle, aktive LTS- oder eine stabile Version von Node.js. Besuchen Sie die Node.js-Website um Node.js herunterzuladen und zu installieren.

  • npm package manager: Angular, das Angular CLI und Angular-Anwendungen sind auf npm-Paketen angewiesen. Der npm package manager wird mit Node.js verteilt und sollte daher bereits auf Ihrem System installiert sein.

  • Angular CLI: Das Angular CLI ist ein Befehlszeilenwerkzeug, das Sie für die Erstellung und Verwaltung von Angular-Anwendungen verwenden können. Installieren Sie das Angular CLI global auf Ihrem System mit dem folgenden Befehl:

    npm install -g @angular/cli

  • Visual Studio Code: Dies ist ein empfohlener Code-Editor für die Arbeit mit Angular. Sie können ihn von der Visual Studio Code-Website herunterladen und installieren. Es enthält hilfreiche Features wie Syntax-Highlighting, Autocomplete, und eine eingebaute Terminal-Konsole.

    Zusätzlich empfehlen wir, die Angular Essentials Extension Pack für Visual Studio Code zu installieren. Dieses Paket enthält eine Sammlung von Erweiterungen, die die Angular-Entwicklung vereinfachen. Sie können es von der Visual Studio Code Marketplace herunterladen.

Folgen Sie diesen Schritten, um das Projekt auf Ihrem lokalen System aufzusetzen:

Backend

  1. Download Strapi Server (Alle Files und Directories) vom new_main Branch (Dieser Ordner muss separat auf dem lokalen Gerät gespeichert sein >> Nicht im selbem Verzeichnis speichern wie das Angular Repo!)

  2. Öffnen der Konsole (CMD bzw. Terminal)

  3. Wechseln ins Strapi Verzeichnis mit cd → Beispiel: cd 99deals_strapi

  4. Starte Strapi Server mit: npx strapi develop --watch-admin --browser 'google chrome' ← (Startet den Chrome Browser automatisch und bringt zum Login des Admin-Panels von Strapi; Port wird selbst automatisch zugewiesen) → Kann einen Moment dauern

  5. Login ins Admin-Panel (Auch ohne Login möglich, Wichtig > Server nicht abschalten, CMD bzw. Terminal offen lassen)

Front-End

  1. Klone das Repository: git clone https://gitlab.ti.bfh.ch/dsl-student-projects/wseg-23-fs/4p-teapot.git
  2. Öffnen einer neuen Konsole (CMD bzw. Terminal)
  3. Wechseln Sie in das Projektverzeichnis: cd 4p-teapot
  4. Starten der Angular-App: ng serve -o, öffnet automatisch den Browser. Kann einen Moment dauern

Die Anwendung sollte nun auf http://localhost:4200 (oder zugewiesenen Port) laufen.

Notwendige Schritte für den ersten Start

Für den ersten Start der Anwendung, nachdem Sie alle Abhängigkeiten installiert und die Anwendung gestartet haben, werden Sie zuerst zur Login-Seite weitergeleitet. Da wir jedoch keine vollständige Authentifizierungsfunktion implementiert haben, werden Sie bei der ersten Anmeldung einen POST-Fehler erhalten, wenn Sie versuchen, sich mit dem Login-Button anzumelden. Dies liegt daran, dass wir keine tatsächlichen Anmeldedaten haben und die Anmeldung nur simuliert wird.

Um diese Anfangshürde zu umgehen und zur Hauptseite der Anwendung zu gelangen, geben Sie bitte /home direkt in die URL-Leiste Ihres Browsers ein. Dies bringt Sie direkt zur Startseite der Anwendung.

Anwendungsnavigation und Sicherheitsrouting

Diese Anwendung wurde entwickelt, um die gängigen Muster und Best Practices einer modernen Webanwendung zu simulieren. Wir haben zwei Arten von Routing-Strukturen implementiert: Authentifizierungsrouten und Modulrouten.

Authentifizierungsrouten

Diese Routen sind dafür verantwortlich, die Authentifizierung zu simulieren. Hier sind die Routen, die wir in dieser Kategorie definiert haben:

Pfad Komponente Beschreibung
/login LoginComponent Zeigt die Login-Seite an.
/signup SignupComponent Zeigt die Anmeldeseite an.
/forgot ForgotPwComponent Zeigt die Seite zum Zurücksetzen des Passworts an.
/ Leitet den Benutzer zur Login-Seite um.
/home HomeModule Leitet den Benutzer zur Hauptseite um. Dieser Pfad verwendet Lazy Loading.
** NotFoundComponent Zeigt eine 404-Seite an, wenn der Benutzer einen nicht existierenden Pfad eingibt.

Modulrouten

Diese Routen gehören zum Home-Modul und leiten den Benutzer zu den verschiedenen Seiten innerhalb dieses Moduls um. Hier sind die Routen, die wir in dieser Kategorie definiert haben:

Pfad Komponente Beschreibung
/about AboutComponent Zeigt die Über-uns-Seite an.
/follow FollowComponent Zeigt die Folgen-Seite an.
/header HeaderComponent Zeigt die Header-Seite an.
/main MainComponent Zeigt die Hauptseite an.
/nav NavComponent Zeigt die Navigationsseite an.
/sponsor SponsorComponent Zeigt die Sponsorenseite an.
/timer TimerComponent Zeigt die Timer-Seite an.
/ Leitet den Benutzer zur Hauptseite um.

Hinweis

Dieses Verhalten wurde bewusst so implementiert, um die Struktur einer echten Anwendung zu simulieren, bei der eine Benutzeranmeldung erforderlich wäre, um auf bestimmte Bereiche der Anwendung zuzugreifen. Wir haben jedoch beschlossen, auf die Implementierung einer vollständigen Authentifizierung zu verzichten, da dies nicht im Fokus unserer App-Entwicklung lag.

Struktur der Anwendung und dynamischer Inhalt

Die Anwendung ist modular aufgebaut und in verschiedene Hauptkomponenten unterteilt, die für spezifische Funktionen innerhalb der Anwendung verantwortlich sind. Hier sind die Schlüsselkomponenten und deren Funktionen:

  • Authentifizierungsmodul: Dieses Modul verwaltet die Authentifizierungsfunktionen der Anwendung und enthält verschiedene Komponenten für den Login, die Registrierung, das Zurücksetzen des Passworts und eine 404-Komponente für die Fehlerbehandlung.

  • Hauptmodul: Dieses Modul umfasst die Hauptseite und besteht aus mehreren spezialisierten Komponenten, darunter:

    Komponente Beschreibung Dynamischer Inhalt von Strapi
    Navigation Die Navigationskomponente enthält das obere Menü mit dem Anwendungslogo und den Navigationsbuttons. Nein
    Hero Diese Komponente präsentiert einen Begrüßungstext und eine kurze Einführung in 99Deals. Ja
    Main Diese Komponente zeigt die Deal-Angebote in einer Spalte an. Ja
    Sponsors Die Sponsorenkomponente zeigt die Logos der Sponsoren an. Ja
    About Diese Komponente zeigt Textabschnitte und das Logo von 99Deals. Ja
    Follow Die Follow-Komponente zeigt die Logos und URLs der Social-Media-Kanäle von 99Deals an. Nein

3rd-Party Libraries for Angular Project

Dieses Projekt verwendet verschiedene Drittanbieter-Bibliotheken, um die Entwicklung zu erleichtern und die Funktionalität zu erweitern. Hier ist eine Liste der Schlüsselbibliotheken zusammen mit ihren jeweiligen verwendeten Versionen:

APIs

Unsere App interagiert mit den folgenden API's:

  • REST API Strapi: Ein Open-Source Node.js Headless CMS, um einfach anpassbare APIs zu erstellen. Wir verwenden Strapi für alle unsere Anforderungen an das Datenmanagement der Anwendung, einschliesslich dem Abrufen und Verwalten der dynamischen Inhalte, die in verschiedenen Komponenten angezeigt werden.

ChangeLog

Änderungsprotokoll seit der letzten Veröffentlichung des Read.me-Files

Wir haben mehrere Änderungen an unserer Single Page Application (SPA) vorgenommen:

  • Integration eines dynamischen Warenkorbs: Unsere Wunschfunktion eines Warenkorbs konnte implementiert werden. Dieser speichert und zeigt die ausgewählten Produkte dynamisch an. Angezeigt werden Artikelname, Menge und Preis in Tabellenform, ähnlich wie bei bekannten Warenkörben. Zudem werden die Gesamtzahl der Artikel (Menge) und deren Gesamtpreis angezeigt. Unter den Gesamtmengen und -preisen befindet sich ein gut sichtbarer Button. Auf der linken unteren Seite des Warenkorbs, gegenüber der Gesamtmenge und dem Preis, findet der Kunde die akzeptierten Zahlungsmethoden.

    1686171474109

    1686171862355

    1686171557751

  • Implementierung der ScrollIntoView-Methode mit einem neuen Directive: Wir haben ein neues Directive generiert und eine ScrollIntoView-Methode implementiert. Damit kann der Benutzer vom Navigationsbereich aus geschmeidig zur gewünschten Komponente navigieren. Hier ist der zugehörige Code:

    import { Directive, Input, ElementRef, HostListener } from '@angular/core';

@Directive({
  selector: '[appSmoothScroll]'
})
export class SmoothScrollDirective {
  @Input('appSmoothScroll') targetElementId!: string;

  constructor(private _el: ElementRef) { }

  @HostListener('click') onClick() {
    this.smoothScroll();
  }

  private smoothScroll() {
    const targetEl = document.getElementById(this.targetElementId);
    if (targetEl) {
      targetEl.scrollIntoView({ behavior: 'smooth' });
    }
  }
}

    Und die Verwendung im HTML:

    <li><a appSmoothScroll="main">Deals of the Day</a></li>
<li><a appSmoothScroll="about">About Us</a></li>
<li><a appSmoothScroll="sponsor">Sponsors</a></li>

  • Hinzufügen eines Icons im AboutComponent: Im AboutComponent haben wir zusätzlich ein Icon integriert, das unseren ersten Satz des AboutComponents symbolisiert und unser Engagement repräsentiert: "Bei 99Deals verstehen wir, dass jeder ein gutes Schnäppchen liebt, und deshalb sind wir verpflichtet, Ihnen die besten Angebote auf dem Markt zu bringen".

    1686171611871