Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 2.7 KB

README.md

File metadata and controls

82 lines (52 loc) · 2.7 KB

Build Status Coverage Status Maintainability Test Coverage

Ride My Way

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. 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.

Relevant Tech Stack

  1. Node.js/express.js: The API was built using Node JS(server side implementation of javascript) and the Express JS framework.
  2. PostgreSQL/node-postgres: PostgreSQL is the database used for this application, with node-postgres being a collection of node.js modules for interfacing with the PostgreSQL database.

Installation and Setup

To get a local version of this application, please make sure to have the following system dependencies installed and ensure postgreSQL has been setup properly,

  1. Clone the repository:
git clone  https://github.com/lexcorp16/ride-my-way.git
  1. Navigate into the cloned repository directory using:
cd ride-my-way
  1. Install dependencies:
npm i
  1. create a .env file and add the required environment variables as defined in the .env.example file
  2. Run the following commands in the specified order to set up your database.
npm run create:enums
npm run create:usertable
npm run create:rideofferstable
npm run create:requeststable
  1. Now run the command below to start the app.
npm run dev

Running tests

To run the tests already written for this application, run

npm test

API Endpoints

See API Documentation

Contact the Author