项目作者: lauragift21

项目描述 :
Ride-My-Way is a carpooling application that provides drivers with the ability to create ride offers and passengers to join available ride offers.
高级语言: JavaScript
项目地址: git://github.com/lauragift21/Ride-My-Way.git
创建时间: 2018-06-11T15:39:52Z
项目社区:https://github.com/lauragift21/Ride-My-Way

开源协议:MIT License

下载


Ride-My-Way

Build Status Coverage Status Maintainability Test Coverage

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

Required Features

  • Users can create an account and log in.
  • Drivers can add ride offers..
  • Passengers can view all available ride offers.
  • Passengers can see the details of a ride offer and request to join the ride. E.g What time
    the ride leaves, where it is headed e.t.c
  • Drivers can view the requests to the ride offer they created.
  • Drivers can either accept or reject a ride request.

Optional Features

  • Users can only see and respond to ride offers from their friends on the application.
  • Passengers get real time notifications when their request is accepted or rejected

Technologies

  • Nodejs
  • Express
  • Mocha, Chai, Babel, eslint
  • Postgres
  • JWT authentication

API Endpoints

Endpoint Functionality
POST /auth/signup Register a user
POST /auth/login Login a user
GET /rides Fetch all available rides
GET /rides/\ Fetch the details of a single ride
POST /users/rides Create a Ride offer
POST /rides/\/requests Make a ride request
GET /users/rides/\/requests Feth all ride requests
PUT /users/rides/\/requests/\ Accept or Reject a ride request

Ride My Way API Documentation

Build Setup

  1. clone repo and cd into directory
  2. git clone https://github.com/lauragift21/Ride-My-Way.git
  1. # install dependencies
  2. yarn install # or npm install
  3. #serve in development environment
  4. yarn run dev
  5. # build for production
  6. yarn run build

Testing

  1. # Run test cases
  2. yarn test

#

API Endpoint: https://ride-my-way-server.herokuapp.com/api/v1
UI Template: https://lauragift21.github.io/Ride-My-Way/UI/index.html

AUTHOR

EGWUENU GIFT

LICENSE

Ride My Way is MIT licensed