Skip to content

eveev26/Scarpool

Repository files navigation

Scarpool

An IOS mobile application created during the Hack the Valley 8 hackathon event at the University of Toronto Scarborough Campus. Contributors: Ivy Chen, Andy Ma, Annie Wu, Ashley Wong

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap

About The Project

Scarpool was created due to the fact that a lot of students at UTSC commute. We wanted to create a solution to help provide transportation exclusively for UTSC students.

What our app provides:
-a place for students requiring commute to search for carpools
-a place for other students with transportation capabilities to advertise their carpools

Given the nature of carpooling, we aim to reduce carbon emissions along with providing transport.

Built With

mongodb express
react nodejs

We used the MERN stack, pretty much.

(back to top)

Getting Started

BEFORE ANYTHING: Please note our project is designed for IOS devices, and you will not be able to see the emulation on Windows computers.
If you would like to set our project up on your local device, you can start by doing the usual git clone and stuff. After doing so, please note our project requires a couple of API keys:
-one from Google Cloud Services using the Javascript Maps API(https://developers.google.com/maps/documentation/javascript/overview)
-one from the (very obscure) Geoapify API(https://www.geoapify.com/)
-and a URI from a MongoDB you will have to create(https://www.mongodb.com/).
Replace our environment variables with your own API keys and URI.

Prerequisites

Here is a list of npm stuff you will need. (Please look up the correct command if we got any of these wrong) Make sure to do these in the backend directory.
npm install express
npm install dotenv (if you also want to use environment variables)
npm install [email protected] (we are using an older version for our purposes)
npm install mongodb

Installation

To sum it up:

  1. Clone the repository
  2. Get the API keys and the URI from the links in "Getting Started" and replace them wherever we used the corresponding environment variable. If it is an API key, replace the whole "process.env.API_KEY" with your API key. If it is the URI, replace the whole "process.env.MONGO_URI" with your URI as well. Create your own .env file if you want. Look up "environment variables javascript" if you need help with that.
  3. That is it, I think. (At the time of writing this, we are not done yet) Go ahead and try out our app for yourself.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

(At the time of writing this, we are not done yet)

Roadmap

  • Finish project
  • Finish Devpost + README
  • Clean up repository
  • Present after hacking time is over
  • Acknowledge that we may not go back to it but it was a good learning experience

Link to Devpost

https://devpost.com/software/scarpool?ref_content=user-portfolio&ref_feature=in_progress

(back to top)

Thanks for checking this project out. We hope you enjoyed learning about this random idea we had. If there's anything we learned, it's that Google ALWAYS knows where we are. Have a good day.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors