A carpooling app for UQ students with the goal of minimising traffic congestion and reducing carbon emissions.
Node v14.17.4 (best to use NVM to manage node version)
Yarn
Navigate to the resective frontend or backend folder.
Once you have the correct version of node running and are in the respective folder
, run yarn install
to install the package dependanices.
To use the google map API's, and the autocomplete, you must have your API key installed. This key should stay private.
GOOGLE_MAPS_API_KEY={Your API Key}
.Project Uses Directions, Places, Geocoding and Distance Matrix APIs enabled.
cd into the UQ-Pool/clientside directory and run yarn install
to install any dependencies.
cd into the UQ-Pool/clientside directory and run yarn start
from your terminal and scan the QR code on your phone.
cd into the UQ-Pool/serverside/Server directory and run yarn install
to install any dependencies.
cd into the UQ-Pool/serverside/Server directory and run node index.mjs
.
leave the server running. (Note it is currently setup to access ports for an
external server ports 7777 you will have to change to run locally.)
The server files are hardcoded to use HTTPS and TLS certs that are stored on the server machine. To use the server yourself, please uncomment the HTTP code, and comment out the HTTPs code. If you wish to use HTTPs on your edition, pleaes set up DNS for your server and create your own certs.
When you use a package, ensure that it gets added to the package.json file by running yarn add [package-name]
. This is done in place of npm install
as well.