Skip to content

Latest commit

 

History

History
125 lines (87 loc) · 3.33 KB

README.md

File metadata and controls

125 lines (87 loc) · 3.33 KB
Raw

Ride My Way

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

Motivation

This is driven by the increase in technology, which has proven to be more effective in time saving. We there fore develop this app to apply tech in the transportation industry with the main purpose of saving more and earning more.

Build status, and test coverage

Build status of continuous integration i.e. travis, - Test coverage of code climate and coveralls -

Build Status Maintainability Test Coverage Coverage Status

Features

  • Users (Driver and passenger) can fetch all ride offers
  • Users can fetch a specific ride offer
  • Driver creates a ride offer
  • Passengers make a request to join a ride.
  • Driver can deletes and update ride offer

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

This describes things needed to install the software.

- git : to update and clone the repository
- python3: The base language used to develop the api
- pip: a python package used to install project requirements

Installing

Type: "git clone https://github.com/reiosantos/ride-my-way.git" in your terminal.

The UI folder houses the user interface. To access the user interface, open the login.html file inside the UI/templates folder

The api folder contains the system backend services.

  • To install the requirements. run:
pip3 install -r requirements

The app can then be run with the following commands.

cd api

python app.py
  • Now you can access the system api via URLs:
  • To access all rides, method[GET]
http://localhost:5000/api/v1/rides/
  • To access a particular ride. ie ride number 5, method[GET]
http://localhost:5000/apis/v1/rides/5/
  • To delete a particular ride for-example 4, method[DELETE]
http://localhost:5000/apis/v1/rides/delete/4/
  • To send a request to join a particular ride for-example 4, method[POST]
http://localhost:5000/apis/v1/rides/4/request/
  • To update a particular ride, method[PUT]
http://localhost:5000/api/v1/rides/update/
  • To insert a new ride, method[POST]
http://localhost:5000/api/v1/rides/

Running the tests

  • To run the tests, make sure you are working under api/, Then run the following commands
pytest

Built With

  • Flask - The web framework used
  • Python - Framework language
  • HTML
  • CSS

Authors

Acknowledgments

  • Andela Software Development Community
  • Inspiration
  • Bootcamp 9 team-mates