V Team SparkRentals

Spark租借項目

內容

• 關於
• 下載
• 用法
• 許可證和工具

關於

該計畫由布萊金厄理工學院網路程式設計專業的 4 名學生創建。我們的任務是為一家踏板車公司創建一個系統，除此之外，我們將為客戶創建一個適合行動裝置的 Web 應用程式、管理 Web 介面、電動踏板車的模擬程式、自行車中的智慧程式Rest API，用於從整個系統分發和檢索資訊並將資訊儲存在資料庫中。

此專案由以下人員創建：

• 卡斯帕·法爾克 / FalkenDev
• 詹姆斯泰勒
• 喬爾·佩爾森
• 奧斯卡伊德伯格

背景

「Svenska Elsparkcyklar AB」公司需要一個管理瑞典城市電動滑板車租賃的系統。該公司在3個不同的城市開展業務，並計劃在新數據系統的支持下擴展到更多城市。

數據系統包括以下幾部分：

• 基於網路的後端解決方案，連接到資料庫以管理自行車、充電站、停車區、允許自行車進入的區域、借出/歸還、自行車收集。
• REST API 可以連接自訂應用程式。
• 管理網路介面，您可以在其中查看自行車、站點和客戶的狀態。
• 客戶的網路介面，以便他們可以登入並查看他們的帳戶、貸款記錄和付款。
• 為客戶提供適合行動裝置的網路應用程序，以便他們可以查看借用/歸還自行車以及查看上次行程的狀態和行程歷史記錄。
• 自行車中的智慧、控制和監控自行車的程序（開啟、關閉、速度、限制速度、位置、需要維修/充電）。

此外，還包括一個選項來模擬整個系統的操作，以便能夠測試和驗證系統的功能。

該專案的儲存庫

• 手機應用程式
• 管理儀表板
• 韋伯客戶端
• 滑板車模擬器
• 休息API
• 數據生成器

下載

所需的環境變數

.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"

在 Docker 上運行整個系統

• 分叉/下載 SparkRentals 圖

• 建立 .env 檔案並插入環境變數並更改輸入。

碼頭工人組成

用法

行動應用程式要使用行動應用程序，您需要掃描二維碼或在行動裝置中輸入連結（需要有expo應用程式）。運行行動應用程式時，可以在終端中找到該連結。

管理儀表板要使用管理儀表板：http://localhost:3000，否則請檢查 docker compose 檔案中的連接埠。

滑板車模擬器要使用滑板車模擬器，您需要按照以下步驟操作：滑板車模擬器。

REST API要使用 REST API：http://localhost:8393/v1/

資料產生器在 docker compose 運行時自動載入。可以按照以下步驟再次運作：資料產生器。

Web 用戶端要使用 webb 用戶端：http://localhost:3000，否則請檢查 docker compose 檔案中的連接埠。

許可證和工具

審查員

手機應用程式

管理儀表板

滑板車模擬器

休息API

網頁客戶端