RIDE MY WAY

• It is a REST Application Programming Interface(API) for sharing a ride if persons are traveling in the same direction.

• Ride - This is a vehicle with passenger space.

• Driver - The Creator of the ride is assumed to be the driver.

• The API is developed in Python/Flask. Consuming the API can be done with any other tech stack that can process JSON endpoints.

Technologies/Tools used & needed.

• FastAPI - Modern, fast (high-performance), web framework for building APIs with Python 3.7+ based on standard Python type hints.
• Virtualenv - A tool to create isolated virtual environments
• SQLITE - Small, fast, self-contained, high-reliability, full-featured, SQL DB.
• Docker / Docker-compose - Set of platform as a service products that use OS-level virtualization to deliver software in packages called containers.
• Alembic is a lightweight database migration tool for usage with the SQLAlchemy Database Toolkit.

Table of Contents

#
*	Installation & Running
*	Testing

Installation

The commands are from a bash terminal

Locally

• Clone the repository.

git clone https://github.com/Xerrex/rmw-API.git

• Change into cloned folder.

cd rmw-API

• Using Pip

  • Create a virtual environment & activate it.

  python3 -m venv venv && source venv/bin/activate
  

  • Install dependancies

  pip install -r requirements.txt
  

• Using uv

  • Setup dependencies

  uv sync
  

  • Activate virtual environment

  source .venv/bin/activate
  

• Create and edit environment variables.

touch cp envExample .env

Running and Testing the app.

Running

• Run the App.

fastapi dev main.py

• View the App serving here
• View API docs here

Testing

• Coming soon.