Vehicle Shifter Backend

Description

Public Service Vehicle commonly known as Matatus usually queue to wait for their turn to carry passengers. The Queuing Process is not done in an ordely way. If the drivers are not keen, they might be skipped by other drivers.
The vehicle shifter app is meant to automate the queuing process. In addition, it can generate reports. The app is made using React JS and FastAPI

Demo

I have a deployed the application on Heroku
click the following link to check the API endpointshttps://vehicle-shifter-api.herokuapp.com/docs

Table of contents

• Prerequisites
• Directory Structure
• Running Locally
• Acknowledgement
• License

Prerequisites

• Python - version 3.7 and above

Directory-Structure

vehicle-shifter-backend
├── auth/
├── config/
├── crud/
├── models/
├── routes/
├── schemas/
├── templates/
├── init.py
├── .env
├── main.py # Application entry point
├── requirements.txt
└── README.md

Setting-up-Local-Environment

clone the repository and navigate to the project directory

git clone https://github.com/maxwellwachira/vehicle-shifter-backend.git
cd vehicle-shifter-backend/

Create a python virtual environment and activate it

python3 -m venv venv
source venv/bin/activate

Install Project dependencies

pip install -r requirements.txt

create a file and name it as .env. Copy contents of .env.example to .env

Acknowledgement

Special thanks to @skndung'u for the idea to make the app.
Special thanks to Sebastián Ramírez aka @tiangolo the creator of FastAPI

License