ibukunolatunde1/ride-my-way

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

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

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.
• Drivers can view the requests to the ride offer they created.
• Drivers can either accept or reject a ride request.

API

API is available at

API DOCUMENTATION

API Documentation is available at

UI

UI Template is available at

Technologies Used

• [NodeJS] (https://nodejs.org/en)
• [ExpressJS] (https://expressjs.com)
• [PostgreSQL] (https://postgresql.org)

Installation

1. Install [node] (https://nodejs.org/en/download/), version 8 or greater

2. Install PostgreSQL

3. Clone the repository

   git clone git@github.com:ibukunolatunde1/ride-my-way.git
   

4. Navigate to the project directory

   cd ~/path/to/ride-my-way
   

5. Install all dependencies

   npm install
   

6. Start the app

   npm run migration:dev
   npm start
   

7. Tests can also be done by

   npm run migration:test
   npm test
   

License

This project is MIT LICENSED