GithubHelp home page GithubHelp logo

atmegabuzz / bookcab Goto Github PK

View Code? Open in Web Editor NEW
29.0 1.0 10.0 5.54 MB

Shared cab booking application using bellman ford algorithm and google maps with web3 based payment system

Python 7.77% HTML 10.09% PHP 0.83% CSS 13.67% JavaScript 60.01% Less 7.16% Dockerfile 0.05% Solidity 0.28% Mako 0.13%
web3 blockchain flask python

bookcab's Introduction

logo

OSMD Book Cab (One Source Multiple Destination)

About OSMD Book Cab

  • Book Cab is a web app that optimizes the rideshare booking approach. This app serves as a single source to help users find the shortest path for multiple destination, shared rides.

  • The goal of this project is to figure out the shortest feasible path from a given starting point using an algorithm. The performance of the developed algorithm will be studied for practical use.

How it Works

  • Works on Bellman-Ford algorithm to compute shortest and optimized path by considering each location as a vertex of the graph.
  • The booking is then paired with max 4 people based on the route and low cost.

What is Bellman-Ford Algorithm

The Bellman–Ford algorithm is an algorithm that computes shortest paths from a single source vertex to all of the other vertices in a weighted digraph.

Features and Interfaces

  1. Registration page

    • image
  2. Booking page

    • image
  3. Your bookings

    • image
  4. Bookings accepted

    • Booking accepted but payment pending
    • image
    • paying using ethereum (SepoliaETH)
    • image
  5. Bookings accepted

    • Booking info of individuals who will be sitting in the same shared cab.
    • image
  6. Your route

    • See your route on your bookings accepted page.
    • image
  7. Chat Functionality

    • image

Getting Started

  • Add google maps API.

    • Create your billing account at google maps platform (google console).
    • Generate Api key to access the services.
    • Add the api to .env file.

  • Setup using docker

    • docker-compose build
    • docker-compose up
  • Setup

    • pip install -r requirements.txt
    • python server.py
  • Run Tests using pytest

    • pip install pytest
    • python -m pytest

bookcab's People

Contributors

atmegabuzz avatar celestial-sailor avatar dependabot[bot] avatar kd-here avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

bookcab's Issues

Write Unite tests

Unit tests for:

Testing Models

  • User
  • Booking
  • CabGroup

Testing Routes

  • Register page (GET,POST)
  • Login page (GET,POST)
  • Home page (GET,POST)
  • Services page (GET)
  • Bookgin Detail Page (GET)

add docker support

We need to containerize the app to easily deploy to cloud platform

  • add a dockerfile
  • add a docker compose

Improve Docs (README)

Improve by adding

  • all images in 1 section
  • more polished info regarding about section
  • Help with grammatical errors.
  • setup docs local
  • setup docs using docker and docker compose
  • testing the application

Add chat for taxi group

  • When a bookings is finalized then a group is made for people based on efficiency of the route
  • a cab group is created for all of them
  • create a chat with room functionality where a taxi group can communicate
  • remember no 2 group's people can chat to each other

Create Login Api endpint

Implement Api version of currently implemented login route in view/auth login.
How

  • just take json instead of form in the route input
  • all main body will be same as normal login route implement in the app
  • return response with success message and 200 status code on user successfully validated

Setup workflows

  • We need to check if build is working in each pr.
  • implement github actions to build the project before merging

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.