yongjiajun / pp-car-share Goto Github PK

View Code? Open in Web Editor NEW

9.0 2.0 2.0 2.66 MB

Car Share Scheme Web App/MERN Stack Development [COSC2408 Programming Project 1, RMIT University 2020]

JavaScript 97.96% HTML 0.66% CSS 1.38%

pp-car-share's Introduction

Car Share Scheme

Car Share Scheme is a web application implemented on a MERN Stack.

Features

Car Share Booking System for customers:
- Overview of Car Share System on landing page
  - Details about the system
  - Cars offered for rental service
  - FAQs
- Location map displaying all the garages in Melbourne with Google Maps API
- Ability to checkout cars at a given pickup/return location
- Account registration to keep track of customer's bookings
- Booking System:
  - Search for available cars by a specified date range
  - Filter available cars in specified date range by car attributes and pickup/return location
  - Make bookings with desired car and time
  - View all of customer's bookings
  - Ability to cancel upcoming bookings
  - Pickup and return car on booking dashboard when it's time, changing booking status
Car Share Admin System for staff members:
- Create/modify locations/garages/car pickup/return spots with address using Google Maps Places API Autocomplete feature
- Create/modify user accounts
- Create/modify cars
- View all of customers' bookings
- Cancel customer's upcoming bookings

Installation

Make sure Node.js is installed on your machine.
MongoDB setup:
1. Make sure MongoDB is installed and running on your machine.
2. Leave credentials as blank.
3. In your environment, export the MongoDB URI as variable MONGO_URI with mongodb://localhost:27017 as the value
Clone repository from https://github.com/yongjiajun/pp-car-share to your desired folder.
To compile the backend code, run npm install in backend/.
To compile the frontend code, run npm install in frontend/.

To run

To make Google Maps API work, export the variable REACT_APP_API_KEY with your Google Maps API key as the value in your environment.
Make sure MongoDB URI is set up as mentioned above.
To start the backend server, run npm install in backend/.To start the frontend server, run npm install in frontend/.

Uninstallation

Stop the backend and frontend servers if they are still running.
Remove the folder containing the repository files and compiled source code.

Code Structure

backend/ contains code for Express.js and also code for maintaining mongodb connection.
- api/ contains code for REST APIs, separated by models.
  - controllers/ contains code for model db controllers.
  - models/ contains code/schema for models.
  - routes/ contains code for routing urls to controllers.
- app.js contains code for Express.js configs such as routings, mongodb connection, CORS handling, etc.
- app_server.js contains code for managing Express.js core configs such as listening port and http/s protocol.
frontend/ contains code for React.js for the frontend of the web application

pp-car-share's People

Contributors

Stargazers

Watchers

Forkers

anto1777 arulfrances

pp-car-share's Issues

Summary

To add car db model with the following attributes:

ID (of course)
Make
Seats
BodyType
Location/coordinates (thoughts?)
NumberPlate
Colour
CostPerHour
FuelType
TotalDistance ??
CurrentBookingID (nullable: if not null = car has been booked, direct access to Booking object using id)

Thoughts and anything to add?
@davidd-code @alexwitedja

Remove landing page Book Now button for staff

Summary

To add booking db model with the following fields:

ID
UserID
CarID
Datetime booked
Datetime start
Datetime end
Cost
Pickup location
Drop location
Distance ??
Status

Thoughts and anything to add?
@davidd-code @alexwitedja

I was thinking of add-ons or extra costs such as toll charges, but I think it's too unnecessary lol.

Fix duplicate log out button on navbar

Fix third party API calls when authorisation header exists

Remove 'Bearer ' from JWT Token

Change location references in create car page

Show Location Name and Address in Booking Confirmation

All of the dropdown boxes in the Create Car form show a default value, but the actual value that is saved in the react state is empty until the user selects a different option from the default value. This means that if a staff or admin wants to add a new car to the database, if they want to create a car with the body type "Sedan", then they have to select a different option first. In this case it would involve clicking the drop down box, changing the body type to either MPV, Hatch, Sports or Ute and then selecting the same field again and selecting Sedan after.