/RIDE-MY-WAY

This is an application that allows user to request for a ride, and the driver accepts or rejects the request.

Primary LanguageJavaScript

RIDE-MY-WAY

Build Status Coverage Status

This is an application that allows user to request for a ride, and the driver accepts or rejects the request.

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/2177910

Template

Template is hosted at https://dinmaotutu.github.io/RIDE-MY-WAY/

API Deployment

API is deployed at https://ride-my-way-cars.herokuapp.com

Documentation

Documentation is hosted at https://ride-my-way-cars.herokuapp.com/api/v1/docs

Technologies

  • NodeJS - Runtime Environment
  • ExpressJs - Web Application Framework
  • npm - Dependency Manager

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

Features

Users

  • sign up and login
  • request for a ride
  • view rides for the day
  • decline or continue with request
  • Make a ride offer
  • Accept a ride request
  • Reject a ride request
  • get notifications
  • view ride history

Getting Started

Installation

  • git clone RIDE-MY-WAY
  • Run npm install` to install packages
  • Run npm run build to build the project
  • Run npm start to start the server
  • Navigate to localhost:8000 in browser to access the application

Testing

Prerequisites

Testing with Postman

Testing with Coverage Data

  • After installing as shown

  • Run npm test

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

Development

You can run npm run start:serve` in development to use Nodemon

Nodemon restarts your code after a file change or type 'rs' to restart.