Carpool

A carpool matcher app that connects employees based on their office hours. Check out the spatial branch for a more advanced solution. The spatial branch creates a route from the user's home to their office. The user can then spatially filter the results table by creating a buffer around their route and finding colleagues that intersect the buffer. The spatial branch uses ArcGIS Online as the backend api.

Using the App

To get started, you will need to set up an application with ArcGIS for Developers in order to implement the authentication. Alternatively, you can choose to use a different Passport Stragegy and make some changes to api/index.js file.

Next, if you don't have one, create an account at mongoDB Atlas. Once you set up your account, you will need to create a file in the api directory of this application called '.env'. In the file, add:

DB_ROUTE=<CONNECTION STRING PROVIDED BY ATLAS>
SESSION_SECRET=<RANDOM STRING>
ARCGIS_CLIENT_ID=<CLIENT FROM AN ARCGIS APP>
ARCGIS_CLIENT_SECRET=<CLIENT_SECRET FROM AN ARCGIS APP>
PORT=3001

To run the web app you must have Node installed. With Node installed, navigate to the client folder of the app and type:

npm install
npm run build

Then navigate to the api folder and type:

npm install
nodemon index.js

The app should start at http://localhost:3001

TODO

To do list

• structure app - MVC
• Set up database/odm - MongoDB/Mongoose
• Create user model
• Create user settings controller
• Create React forms component for user settings
• Create React data table component
• Filter results table based on distance, time, and driver/passenger
• Create React home/info page
• Set up jwt or passport
• Impmlement a time range slider for filtering the results
• Create option to remove yourself from list
• Consider filter algorithm rework: what if people's filters do not match up?
• Stop procrastinating

Built With MERN Stack

• MongoDB - Database
• Mongoose - ODM
• Express - Backend Framework
• Express Session - Sessions for Express
• React - Frontend Framework
• Reactstrap - Bootstrap for React
• Node - Backend

Other Packages

• axios - REST Requests
• body-parser - Reading Forms
• cookie-parser - Reading Sessions
• connect-mongo - MongoDB Session Store
• compression - Route Compression
• helmet - Express Security Headers
• moment - Time/Date Util
• moment-range - Ranges for Moment
• mobx - Data Store
• mobx react - MobX for React
• passport - Auth
• passport-arcgis - Passport for ArcGIS