Urban Mobility Backend System

A console-based application to securely manage a system of admins, service engineers, travelers and scooters.

---

Running

You can run this program using a Python virtual environment, or using the Dockerfile

Using python virtual environment

To run the program, first create a Python virtual environment

python -m venv .venv/

Then activate the virtual environment

Windows

.\.venv\Scripts\activate.bat

Linux

source .venv/bin/activate

Then install the required packages

pip install -r requirements.txt

Then run the program

python app/main.py

---

Using the Dockerfile

First, make sure you have Docker installed

Then, build the Docker image

Windows

docker build -t urban_mobility_system .

Linux

docker build -t urban_mobility_system .

Finally, run the Docker container from the created image.

Windows

docker run -it --rm -v ./data:/app/data:rw urban_mobility_system

or, to keep persistent data storage

docker run -it -v ./data:/app/data:rw urban_mobility_system

Linux

docker run -it --rm -v ./data:/app/data:rw urban_mobility_system

or, to keep persistent data storage

docker run -it -v ./data:/app/data:rw urban_mobility_system

---

Feature checklist

Service Engineer

• To update their own password
• To update some attributes of scooters in the system
• To search and retrieve the information of a scooter

System Administrator

• To update their own password
• To update attributes of scooters in the system
• To search and retrieve the information of a scooter
• To check the list of users and their roles
• To add a new Service Engineer to the system
• To update an existing Service Engineer account and profile
• To delete an existing Service Engineer account
• To reset an existing Service Engineer password (a temporary password)
• To update his own account and profile
• To delete his own account
• To make a backup of the backend system
• To restore a specific backup of the backend system. For this purpose, the Super Administrator has generated a specific ‘one-use only’ code to restore a specific backup
• To see the logs file(s) of the backend system
• To add a new Traveller to the backend system
• To update the information of a Traveller in the backend system
• To delete a Traveller record from the backend system
• To add a new scooter to the backend system
• To update the information of a scooter in the backend system
• To delete a scooter from the backend system
• To search and retrieve the information of a Traveller

Super administrator

• To update the attributes of scooters in the system
• To search and retrieve the information of a scooter
• To check the list of users and their roles
• To add a new Service Engineer to the backend system
• To modify or update an existing Service Engineer account and profile
• To delete an existing Service Engineer account
• To reset an existing Service Engineer password (a temporary password)
• To see the logs file(s) of the backend system
• To add a new Traveller to the backend system
• To update the information of a Traveller in the backend system
• To delete a Traveller from the backend system
• To add a new scooter to the backend system
• To update the information of a scooter in the backend system
• To delete a scooter from the backend system
• To search and retrieve the information of a Traveller
• To add a new System Administrator to the backend system
• To modify or update an existing System Administrator account and profile
• To delete an existing System Administrator account
• To reset an existing System Administrator password (a temporary password)
• To make a backup of the backend system and to restore a backup
• To allow a specific System Administrator to restore a specific backup. For this purpose, the Super Administrator should be able to generate a restore-code linked to a specific backup and System Administrator. The restore-code is one-use-only
• To revoke a previously generated restore-code for a System Administrator