V Team SparkRentals

SparkRentals-Projekt

Inhalt

• Um
• Herunterladen
• Verwendung
• Lizenz und Tools

Um

Dieses Projekt wurde von 4 Studenten erstellt, die am Blekinge Institute of Technology Webprogrammierung studieren. Wir erhielten die Aufgabe, für ein Rollerunternehmen ein System zu erstellen, in dem wir unter anderem eine mobil angepasste Web-App für den Kunden, eine administrative Webschnittstelle, ein Simulationsprogramm für die Elektroroller und ein Intelligenzprogramm im Fahrrad erstellen würden und eine Rest-API, die Informationen vom gesamten System verteilt und abruft und die Informationen in einer Datenbank speichert.

Das Projekt wird erstellt von:

• Kasper Falk / FalkenDev
• James Taylor
• Joel Persson
• Oscar Idberg

Hintergrund

Das Unternehmen „Svenska Elsparkcyklar AB“ benötigt ein System, das die Vermietung von Elektrorollern in schwedischen Städten verwaltet. Das Unternehmen ist in drei verschiedenen Städten tätig und plant, mit Unterstützung eines neuen Datensystems auf weitere Städte zu expandieren.

Das Datensystem besteht aus folgenden Teilen:

• Webbasierte Lösung für das Backend mit Anbindung an eine Datenbank zur Verwaltung von Fahrrädern, Ladestationen, Parkzonen, erlaubten Einfahrzonen, Ausleihe/Rückgabe, Fahrradabholung.
• REST-API mit der Möglichkeit, benutzerdefinierte Anwendungen anzubinden.
• Administrative Weboberfläche, auf der Sie den Status von Fahrrädern, Stationen und Kunden sehen können.
• Webschnittstelle für den Kunden, damit er sich anmelden und sein Konto, seinen Kreditverlauf und seine Zahlungen einsehen kann.
• An Mobilgeräte angepasste Web-App für den Kunden, mit der er das Ausleihen/Rückgeben des Fahrrads sowie den Status der letzten Fahrt und den Verlauf der durchgeführten Fahrten einsehen kann.
• Die Intelligenz im Fahrrad, Programme, die das Fahrrad steuern und überwachen (Ein, Aus, Geschwindigkeit, Grenzgeschwindigkeit, Position, Service/Aufladung erforderlich).

Darüber hinaus besteht die Möglichkeit, den gesamten Systembetrieb zu simulieren, um die Funktion des Systems testen und verifizieren zu können.

Repositorys für dieses Projekt

• Mobile App
• Admin-Dashboard
• Webb-Client
• Rollersimulator
• REST-API
• Datengenerator

Herunterladen

Erforderliche Umgebungsvariablen

.env:

 #---------------------------------- General ----------------------------------
# -> Configs
API_TOKEN=["API TOKENS"]
JWT_SECRET="JWT Sercret Code"
# Database Location (MongoDB)
DBURI="mongodb://mongodb_container:27017"

#---------------------------------- Dummy Generator ----------------------------------
# -> Configs
CREATE_USER=100
CREATE_PREPAID=100

#---------------------------------- Scooter ----------------------------------
# -> Configs
GEOAPIFY_KEY="Geoapify API Key"
NUMBER_OF_SCOOTERS=50
UPDATE_FREQUENCY_MILLISECONDS=1000
BATTERY_DEPLETION_RATE=0.0005
SIMULATION_CITY=Karlskrona
SIMULATION_ROUTE_PADDING=10

#"DROP ZONE" of scooters
#KARLSKRONA
SIMULATION_MAX_LAT="56.166217"
SIMULATION_MIN_LAT="56.158594"
SIMULATION_MAX_LON="15.593868"
SIMULATION_MIN_LON="15.583096"

#SIMULATION
SIMULATION_EMAIL="The Simulator Account Email"
SIMULATION_PASSWORD="Password to the Simulator Account"

#-------------- REST API URLS ------------------------------
API_URL=http://URL:8393/v1

#---------------------------------- REST API ----------------------------------
# Localhost URL
GOOGLE_CALLBACK_URL="http://"URL-TO-REST-API":8393/v1/auth/google/callback"
GOOGLE_SUCCESS_URL="http://"URL-TO-WEBB-CLIENT":3000/login/google/success"
GOOGLE_FAILURE_URL="http://"URL-TO-WEBB-CLIENT":3000/login/google/failure"

# -> Configs
REST_API_PORT=8393
GOOGLE_CLIENT_ID="Google Client ID"
GOOGLE_CLIENT_SECRET="Google Client Secret Code"
COOKIE_KEY="Cookie Secret Code"
CREATE_SINGLE_PREPAID=2
API_CLUSTER=false

#---------------------------------- REACT ----------------------------------
#SparkRentals
REACT_APP_API_URL="http://"URL-TO-REST-API":8393/v1"

# -> Configs
REACT_APP_REST_API_KEY="React Admin API KEY"
REACT_APP_MAP_UPDATE_INTERVAL_BOOLEAN=1
REACT_APP_MAP_UPDATE_INTERVAL=1000
PORT=3000

#---------------------------------- REACT NATIVE ----------------------------------
API_KEY="Mobile API KEY"

Führen Sie das gesamte System auf Docker aus

• Forken/Laden Sie die SparkRentals-Karte herunter

• Erstellen Sie eine .env-Datei, fügen Sie die Umgebungsvariablen ein und ändern Sie die Eingaben.

Docker komponieren

Verwendung

Mobile App Um die Mobile App zu nutzen, müssen Sie den QR-Code scannen oder den Link in das Handy eingeben (Sie benötigen die Expo-App). Der Link ist im Terminal zu finden, wenn Sie die mobile App ausführen.

Admin-Dashboard So verwenden Sie das Admin-Dashboard: http://localhost:3000, andernfalls überprüfen Sie den Port in der Docker-Compose-Datei.

Scooter-Simulator Um den Scooter-Simulator zu verwenden, müssen Sie die Schritte unter: Scooter-Simulator befolgen.

REST-API So verwenden Sie die REST-API: http://localhost:8393/v1/

Der Datengenerator wird automatisch geladen, wenn Docker Compose ausgeführt wird. Kann erneut ausgeführt werden, folgen Sie den Schritten unter: Datengenerator.

Webclient So verwenden Sie den Webb-Client: http://localhost:3000, andernfalls überprüfen Sie den Port in der Docker-Compose-Datei.

Lizenz und Tools

Prüfer

Mobile App

Admin-Dashboard

Rollersimulator

REST-API

Web-Client