Ride-My-Way

Ride-My-Way App is a carpooling application that provides drivers with the ability to create ride offers and passengers to join available ride offers.

Installation - UI

To get a view of the front-end UI, do the following:

Clone the repository into your local environment: git clone https://github.com/graycadeau/Ride-My-Way.git

Navigate to Ride-My-Way directory you just cloned: cd Ride-My-Way/UI

Run index.html file in your browser.

UI link to gh-pages: https://graycadeau.github.io/Ride-My-Way/

Installation - API

Requirements

Recommended set up on your local environment before getting started

1. python 3
2. Git
3. Working browser or Postman
4. virtualenv for an isolated working environment.

Do the following:

1. Clone the repo into a folder of your choice: git clone https://github.com/graycadeau/Ride-My-Way.git from your local terminal
2. Navigate to the cloned folder cd Ride-My-Way
3. Create a virtual environment virtualenv venv
4. Activate the virtual environment source venv/bin/activate
5. Install all dependencies into your virtual environment pip install -r requirements.txt

Run the API

Get the app running by typing python run.py

Test API endpoints

Fire up Postman to test the endpoints. Screenshot from postman

POST/api/v1/rides : creates a ride offer

GET/api/v1/rides : gets all ride offers

GET/api/v1/ride/ : gets a ride offer

DELETE/api/v1/ride/ : delete a ride offer