Skip to content

A web app that displays the closest petrol stations to your current location with their prices. Used to find the closest, cheapest petrol station. Fuel 4 Less.

Notifications You must be signed in to change notification settings

sunnykath/Fuel4Less

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Fuel 4 Less

SOFTENG 750 - Team Pink Porcupine

A web app that displays the closest petrol stations to your current location with their prices. Used to find the closest, cheapest petrol station. Fuel 4 Less.

Required technology stack installation: -VSCode -NodeJS -ReactJS -ExpressJS -MongoDB


Deployment from command line:

  1. Open cmd
  2. cd to the project directory
  3. Open the project in VSCode with the command "code ."

Frontend deployment:

  1. Open a new terminal window
  2. Type "cd frontend"
  3. Run npm install in the terminal (type: "npm install")
  4. Run "npm start" or click on the start - frontend under NPM SCRIPTS, frontend\package.json

Backend deployment:

  1. Open a new terminal window
  2. Type "cd backend"
  3. Run npm install in the terminal
  4. Run npm start or click on the start - backend under NPM SCRIPTS, backend\package.json

Deployment from VSCode:

  1. Click File -> Open folder...
  2. Navigate to the folder where "se750-2021-group4" directory is located
  3. Click open folder
  4. Frontend and backend folders should be present in working directory

Frontend deployment:

  1. Open a new terminal window
  2. Type "cd frontend"
  3. Run npm install in the terminal (type: "npm install")
  4. Run "npm start" or click on the start - frontend under NPM SCRIPTS, frontend\package.json

Backend deployment:

  1. Open a new terminal window
  2. Type "cd backend"
  3. Run npm install in the terminal
  4. Run npm start or click on the start - backend under NPM SCRIPTS, backend\package.json

NOTE: if the NPM SRIPTS don't show in the bottom lefthand corner, click package.json once) (NOTE: if running in development mode, run nodemon - backend instead


FEATURES:

  • Consumers are able to browse cheapest fuel prices without having to sign up
  • Petrol station owners/managers can sign up to the platform as users
  • Users can add petrol stations, and also update prices for their stations.
  • Consumers of the app can see the closest and cheapest petrol stations to them on an interactive map with pins.
  • These petrol stations can also be seen in a list view.
  • Provides information on whether the petrol stations have other amenities, such as barista, toilet and carwash.
  • Side navigation bar is implemented for the ease of access between different pages of the app.
  • Soft colours have been used to be easy on the consumers eyes.

TESTING:

BackEnd Testing: Schemas and Posts

About

A web app that displays the closest petrol stations to your current location with their prices. Used to find the closest, cheapest petrol station. Fuel 4 Less.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •