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

网页客户端