Giter Club home page Giter Club logo

ride-my-way's Introduction

Build Status Coverage Status Maintainability

Ride-My-Way

Ride my way connect drivers and passengers together so that a passenger can get a ride through the Ride-My-Way app. An application that allows passengers to make request to rides offered by drivers.

Table of Contents

Pivotal Tracker

Project is currently being built with the Project Management Tool, Pivotal Tracker. You can find the template at https://www.pivotaltracker.com/n/projects/2179186

Application

Application is hosted at https://ridemyway-danieladek.herokuapp.com/App/src/markup/index.html

Template

Template is hosted at https://danieladek.github.io/Ride-My-Way/UI/

API Deployment

API is deployed at https://ridemyway-danieladek.herokuapp.com/api/v1/rides

Documentation

Documentation is hosted at https://ridemyway-danieladek.herokuapp.com/api-docs

Technologies

Supporting Packages

Linter(s)

Compiler

  • Babel - Compiler for Next Generation JavaScript

Test Tools

  • Mocha - JavaScript Test Framework for API Tests
  • Chai - TDD/BDD Assertion Library for Node library for testing node.js HTTP servers
  • nyc - Code Coverage Generator

Features

  • Signup and Login
  • Create Rides Offers
  • Accept Or Reject A Request As A Driver
  • Get Notifications On Driver's Action
  • Modify Profile
  • Make A Request To An Available Ride As A Passenger
  • Get Notifications On Driver's Response
  • Reset Password Where Neccessary

Getting Started

Installation

Testing

Prequisites

  • Postman - API Toolchain to test enpoint

Testing with Postman

Testing with Coverage Data

  • After installing as shown

  • Run npm run test

  • It will lint code, run test and display coverage data as generated by Istanbul's nyc

Development

You can run npm run start:dev in development to use Nodemon

Nodemon watches for file changes and restarts your code.

Api-endpoints

Open the postman and test the following existing routes
API HTTP verb Action
/api/v1/signup POST Create new user
/api/v1/login POST Log in user
/users/rides POST Create new ride offer
/rides/{rideId} GET Get a ride
/rides/{rideId}/request POST Request a ride
/user/forget-password PUT Generate a token to reset your password
/user/reset-password PUT Create a new password
/users/rides/{rideId}/requests/{requestId} PUT Accept or Reject a ride
/user/rides/{rideId}/requests GET Fetch all requests to a ride
/user/requests GET Fetch all requests of a user
/user/passengers/requests GET Fetch all requests to a ride
/rides GET Fetch all available rides
/user/rides GET Fetch all rides of a user

ride-my-way's People

Contributors

akdan avatar danieladek avatar

Watchers

 avatar

Forkers

akolliy1

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.