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

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.

Courtesy of ALC and forloopTz

Functionality of Web App

• User Authentication ( Signup, Signin & Verification )

• User can do the following:

  • View all available ride offers.
  • See the details of a ride and respond to it
  • Offer a ride
  • View and accept requests for the ride offer he/she created

• User profile which, at minimum diplays:

  • The number of rides the user has given
  • The number of rides the user has takes
  • List of rides taken and given

Tools and Languages used

Tools

• Atom (code Editor)
• nodeJs
• Travis CI
• Jest and Supertest

Languages

• Html
• Css
• Javascript

Getting started

Requirements

• nodeJs

• yarn (Optional)

Project setup

Install nodejs dependencies:

yarn install

If you are using npm

npm install

Lets run some tests

Call the test command

yarn test

Start Dev server

Start the development server and get cracking

yarn dev

ride-my-way's Issues

Offer a ride

Password Reset

• User should be able to reset there password
• Required details are email / phonenumber

Test ride offer api

Test case for :

• Endpoint: api/v1/rides
• method : get
• Expected response: array of ride objects

Request to join a ride

Api endpoint to a join a ride:

• Endpoint: api/rides/:id/requesr
• method : post
• data: { userId, rideId}

Project Setup

Todo

• Create backend folder
• Install dependences
• Express
• Jest
• Eslint

Database setup and migration

• Postgres installation
• Postgres setup

Add some colors

• choose a color scheme
• Apply it to every page

User login

Details:

• Endpoint: /auth/login
• method : post
• data : user details

{
email: "",
password: ""
}

Expected behaviour:

• User gets authenticated
• token is returned

Document Api using swagger

Todo:

• Setup Swagger
• Document Auth Routes
• Document Other routes

Set up test env

• Setup test enviroment
• write first test to test the root route

View all available ride offers

As a user I should be able to view the available offers in summary

Details to be shown

• Ride time
• Ride start and destination
• Ride price
• Driver
• Thumbnail Image

Accept or reject a ride request.

Details:

• Endpoint: /users/rides//requests/
• method : put

Expected behaviour:

• Return success message of action selected

React setup

• Install react and dependencies to the project
• This is done using create-react-app

Get Ride offers

Api end point to get a list of all ride offers

Details:

• Endpoint: /auth/login
• method : post
• data : user details

Expected behaviour:

• array of ride objects

User profile

Should show

• The number of rides the user has given
• The number of rides the user has taken
• List of rides taken and given

Create a ride offer

Api endpoint to create ride order:

• Endpoint: api/rides
• method : post
• data : ride object

Expected behaviour:

• Rides array object should increase size by one

Detailed view of an available offer

As a passengers I should be able 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

Main screen

Header with links to

• Signout
• Notifications
• Profile

List ride offers

User Login

As a user I should be able to login into my account

• Login details required is phone number and password

• Redirects:

• Reset Password

• Signup

User Verification

A user login or registration has to be verified either using email or sms by sending an OTP

• User will receive OTP
• User will enter OTP
• User gains acces to the platform
• If its a new user send to Setup Screen

Setup CI

Continuous Intergration using Travis CI

• Install Travic CI
• Set up in project

I have no Idea what im doing, Its gonna be fun

User Registration

A user should be able to register with ride my way

• User details required to register are phonenumber / email

User verification

Details:

• Endpoint: /auth/verify
• method : post
• data :

{
tokan: "",
code: ""
}

Expected behaviour:

• User to get email, or sms with otp

User auth

• Setup user auth
• Setup JWT architecture

User Registration

Details:

• Endpoint: /auth/register
• method : post
• data : user details

{
email: "",
fname: "",
lname: "",
password: ""
}

Expected behaviour:

• User to get email, or sms with otp

View ride request and offers

• view notifications for ride requests

• Either accept or reject a ride request

Delete ride offer

Details:

• Endpoint: /rides/:id
• method : delete
• data : id

Expected behavior:

• Ride to be deleted

Fetch all ride requests offered by a user

Details:

• Endpoint: /users/rides//requests
• method : GET

Expected behaviour:

• User list of rides they offered

Module not found

frontend/src/index.js
Module not found: Can't resolve 'react-router-dom'

after running: npm run dev

Integrate coveralls

• Integrate test coverage reporting
• Install coveralls to repo
• Add coveralls badge to repo

Get a specific ride order

Api endpoint to get a specific ride order:

• Endpoint: api/rides/{id}
• method : get
• response: ride object