CocktailShaker-App/Readme.md

CocktailShaker App

English Readme

Dieses Projekt unterstützt Node bis zur Version 17.

Ein Projekt für die Veranstaltung Content Verwertungsmodelle und ihre Umsetzung in mobilen Systemen unter Dr. Jürgen Nützel.

Für den Rahmen der App war vorgegeben:

• eine Native oder Hybride App für mobile Endgeräte
• mindestens ein Sensor des Endgeräts muss verwendet werden (Kamera, Geolocation,...)
• die App muss sich mit einem Server verbinden (keine offline App)

Warnung

Das Projekt ist nicht kommerziell. Es ist lediglich ein Projekt während einer universitären Veranstaltung. Alle Informationen, Ressourcen oder Markennamen, die im Text vorkommen oder auf den Fotos zu sehen sind, werden nur zu Informations- und Demonstrationszwecken bereitgestellt. Jegliche Art von direktem oder indirektem Marketing wird nicht angenommen. Die Autoren des Projekts warnen vor den Schäden, die Alkohol anrichtet, und übernehmen keine Verantwortung für ein Ergebnis der Verwendung der eingestellten Inhalte. Alle Cocktailrezepte dienen nur zur Information. Bei der Erstellung dieses Projekts wurden keine Food-Blogger, Barkeeper oder Programmierer geschädigt.

Releases

Übersicht aller Releases. Downloade die App von dort.

• Version 1.1
  • Favourisieren aus Shake-Sicht möglich
  • Logo auf Startseite
  • kleine Verbesserungen und Bugfixes
• Version 1.0
  • grundlegende Funktionen implementiert
  • editieren nicht möglich

Open Bugs, Issues & ToDos

• Shake: Scroll-to-top funktioniert nicht
• New Cocktail
  • Zutat verschwindet bei hinzufügen einer neuen Reihe
• Edit Cocktails
  • Cocktail Zutat zeigen
  • Speichern ermöglichen
• API Key
  • Key nicht gespeichert

Quellen und Bibliotheken

• die CocktailDB API; der eigene API Schlüssel kann in der App gespeichert werden
• Cocktails der International Bartenders Association (Teijo), bereitgestellt durch Teijo
• Gläser Icons von mikeyhogarth
• Bibliothek für Apps Ionic
• JS Framework Vue
• Kompabilität für mobile Systeme Capacitor
• das Logo wurde mit dem Ionic Get started Tool erzeugt

Lokal weiterentwickeln

1. Installiere NodeJS in der aktuellen LTS Version (>=14.15)
2. Installiere die Ionic CLI ionic global: npm install -g ionic
3. Klone das Repository git clone https://github.com/wieerwill/cocktailshaker-app.git
4. In den neuen Ordner wechseln cd cocktailshaker-app
5. Pakete mit npm install installieren
6. den Entwicklungsserver mit ionic serve starten
7. Folge dem Link in der Konsole um die App im Browser oder Smartphone zu betrachten

Build & Deploy

1. Um alles für eine produktionsfertige App bereitzustellen führe npm run build oder ionic build aus. Das erstellt und updatet alle Dateien im dist/ Ordner (für Webseiten Deploy)
2. nach jedem Build Prozess müssen die Capacitor Ordner aktualisiert werden: ionic cap copy
3. nach Updates oder großen Änderungen des Codes (neues Plugin) muss Capacitor synchronisiert werden: ionic cap sync

• Web build
  • ist bereits fertig im dist/ Ordner verfügbar
• Android build
  1. Du benötigst AndroidStudio
  2. die App im Android Studio öffnen ionic cap open android
  3. Android benötigt eine Übersicht nötiger Berechtigungen in android/app/src/main/AndroidManifest.xml
  4. Um die App im AppStore zu veröffentlichen benötigst musst du diese signieren. Für lokale Tests ist eine Beispieldatei unter android/signing/keystore.properties.example
  5. Möglicherweise musst du den Wert von storeFile für deine Platform anpassen

     storeFile=~/.android/debug.keystore
     

• iOS build
  1. es wird XCode auf einem Mac benötigt
  2. die App in XCode öffnen ionic cap open ios
  3. in XCode müssen die Berechtigungen und Berechtigungstexte angepasst werden, zu finden im Tab "Info"
  4. die App muss signiert werden über Signing & Capabilities

Lizenz

Das Projekt läuft unter der MIT Lizenz.