GoRidey - A Ride Sharing Platform

GoRidey is an awesome platform for both Passengers and Riders to initiate, start and end a ride. The idea is very similar to Grab https://www.grab.com/sg/ or Gojek https://www.gojek.com/sg/ in Singapore.

Design Architecture

Created using Mural

Microservice Design Considerations

1. Authentication Management

• User Registration
• User Login with credentials, assign JWT Token embeded in Cookie
• User Logout

2. User Management

• User Get Profile Data
• User Update Profile Data
• User Update Password

3. Ride Management

• Ride Initialization by Passenger
• Get All Pending Ride Requests for Rider
• Ride Acception by Rider
• Ride Cancellation by Passenger for Pending Rides and Rider for On-going Rides
• Ride Completion by Rider upon reaching the destination
• Get All Ride Histories and Display in reverse choronological order

What are the Development Tools & Methods Used?

GoRidey is developed using the following tools:

• Developed using Microservice architecture, specifically Authentication, User and Ride Managements
• Back-end: Golang server using Mux Router
• Front-end: React.js & Bootstrap
• CORS Middleware: Moesif Origin & CORS Changer
• Database: MySQL

How to Use?

Pre-requisites:

• Installed Node.js package and environment, able to run npm commands.
• Installed Golang package and environment, able to run go commands.
• Installed MySQL Workbench
• Installed Moesif Orgin & CORS Changer on Chrome.

Let's Dive into Actions!

1. Clone https://github.com/Chen-Han-NP/ride-sharing-platform.git into your new working repository.
2. Open your MySQL Workbench, make sure the server credentials are as followed: user is root, password is password and database server port number is 3306, as the connection string in Golang server are set to "root:password@tcp(127.0.0.1:3306)/" in default.
3. MySQL script is located at: RIDE-SHARING-PLATFORM/MySQL/RideSharingDBSetup.sql, please find and run the script to set up a database with two default Users and two default completed Rides.
4. To set up the Microservices, please run the following commands:

• cd Microservices/Authentication
• go run auth.go
• cd Microservices/User
• go run user.go
• cd Microservices/Ride
• go run ride.go
• Ports 5050, 5051, 5052 are used for these three Microservices.

5. To start the front-end website, in your Terminal/Command Prompt, run:

• npm run start to start the development mode for the React and the website is hosted on:
• http://localhost:3000.

6. It should automatically opens up your default browser, next, set up the Cors Middleware
   Download: Moesif Orgin & CORS Changer
   Under Advanced Settings:

• Change the Allow-Control-Allow-Origin as where the React website is hosted.
• Change the Set-Control-Allow-Credentials to true

7. You're now free to explore!

Deployment

• Branch gh-pages is set for future deployment at Github Pages, using command npm run deploy, page is currently active at https://chen-han-np.github.io/ride-sharing-platform/, but not up-to-date with developing codes.

Credits

• This project was bootstrapped with Create React App.
• Some part of the codes are referred from: https://www.bezkoder.com/react-login-example-jwt-hooks/ for Register and Login functions.
• Special credit to: https://www.youtube.com/watch?v=b9eMGE7QtTk&t=767s&ab_channel=JavaScriptMastery & https://www.youtube.com/watch?v=hQAHSlTtcmY&ab_channel=WebDevSimplified for teaching the basics of React.js
• And many more awesome Stack Overflowers for solving existing issues regarding Cors, Cookies and JWT tokens! :)