lupyana / ride-my-way Goto Github PK

Api endpoint to a join a ride:

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

Details:

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

{
email: "",
password: ""
}

Expected behaviour:

• User gets authenticated
• token is returned

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

Header with links to

• Signout
• Notifications
• Profile

List ride offers

Details:

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

Expected behaviour:

• User list of rides they offered

• Setup user auth
• Setup JWT architecture

Details:

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

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

Expected behaviour:

• User to get email, or sms with otp

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

• Login details required is phone number and password

• Redirects:

• Reset Password

• Signup

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

Details:

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

Expected behaviour:

• Return success message of action selected

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

after running: npm run dev

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

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

• choose a color scheme
• Apply it to every page

Todo:

• Setup Swagger
• Document Auth Routes
• Document Other routes

• view notifications for ride requests

• Either accept or reject a ride request

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

A user should be able to register with ride my way

• User details required to register are phonenumber / email

Todo

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

Continuous Intergration using Travis CI

• Install Travic CI
• Set up in project

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

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

• Postgres installation
• Postgres setup

Api endpoint to get a specific ride order:

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

Test case for :

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

Should show

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

Api endpoint to create ride order:

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

Expected behaviour:

• Rides array object should increase size by one

Details:

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

{
tokan: "",
code: ""
}

Expected behaviour:

• User to get email, or sms with otp

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

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

Details:

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

Expected behavior:

• Ride to be deleted