Ride-My-Way

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

Table of Content

1. Built With
2. Application Features
3. How to use
4. Author
5. License

Built With

• HTML5 & CSS3
• NodeJS
• Express
• body-parser
• Express-validator

Deployment

Ride-My-Way UI is hosted on gh-pages while the app is hosted on Heroku

• Github Page
• Pivotal Tracker
• Heroku app

Application Features

• Authenticated users can signin
• users can signup
• Authenticated users can create ride offers
• users can view ride offers
• users can view specific ride offer details
• Authenticated users can make ride request to join ride
• Authenticated users can accept or reject ride
• Authenticated users can view number of ride given/taken
• Authenticated users can view list of rides given/taken

API Endpoint

Endpoint	Functionality
GET /rides	Fetch all ride offers
GET /rides/:id	Fetch a single ride offer
POST /rides	Create a ride offer
POST /rides/:id/request	Make a request to join a ride

How to use

Prerequisite

To clone and run this application, you'll need git and Node.js(which comes with npm) installed on you computer.

Installing

From your command line

# Clone this repository
$ git clone https://github.com/Luckzman/Ride-My-Way.git

# Go into the repository directory
$ cd Ride-My-Way

# Install dependencies
$ npm install

# run the app
$ npm start

Running Test

• Navigate to the project root directory
• After installation, run npm test

Author

Lucky Omokarho Oniovosa

License

ISC