Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benelan/carpool
App for connecting colleagues to carpool based on office hours and commute proximity.
https://github.com/benelan/carpool
arcgis bootstrap esri express gis mongodb node react
Last synced: about 23 hours ago
JSON representation
App for connecting colleagues to carpool based on office hours and commute proximity.
- Host: GitHub
- URL: https://github.com/benelan/carpool
- Owner: benelan
- Created: 2019-11-04T17:56:35.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T17:56:55.000Z (over 1 year ago)
- Last Synced: 2024-04-19T06:45:28.188Z (6 months ago)
- Topics: arcgis, bootstrap, esri, express, gis, mongodb, node, react
- Language: JavaScript
- Homepage:
- Size: 1.38 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://developers.arcgis.com/documentation/core-concepts/security-and-authentication/accessing-arcgis-online-services/) in order to implement the authentication. Alternatively, you can choose to use a different [Passport Stragegy](https://www.passportjs.org/packages/) and make some changes to `api/index.js` [file](https://github.com/benelan/carpool/blob/master/api/index.js#L14).
Next, if you don't have one, create an account at [mongoDB Atlas](https://docs.atlas.mongodb.com/getting-started/). 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=
SESSION_SECRET=
ARCGIS_CLIENT_ID=
ARCGIS_CLIENT_SECRET=
PORT=3001
```
To run the web app you must have [Node](https://nodejs.org/en/) 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
- [x] structure app - MVC
- [x] Set up database/odm - MongoDB/Mongoose
- [x] Create user model
- [x] Create user settings controller
- [x] Create React forms component for user settings
- [x] Create React data table component
- [x] Filter results table based on distance, time, and driver/passenger
- [x] Create React home/info page
- [x] Set up jwt or [passport](http://www.passportjs.org/packages/passport-oauth2/)
- [ ] Impmlement a [time range slider](http://react-component.github.io/slider/examples/range.html) for filtering the results
- [x] 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](https://www.mongodb.com/) - Database
* [Mongoose](https://mongoosejs.com/) - ODM
* [Express](https://expressjs.com/) - Backend Framework
* [Express Session](https://github.com/expressjs/session) - Sessions for Express
* [React](https://reactjs.org/) - Frontend Framework
* [Reactstrap](https://reactstrap.github.io/) - Bootstrap for React
* [Node](https://nodejs.org/en/) - Backend
### Other Packages
* [axios](https://github.com/axios/axios) - REST Requests
* [body-parser](https://www.npmjs.com/package/body-parser) - Reading Forms
* [cookie-parser](https://github.com/expressjs/cookie-parser) - Reading Sessions
* [connect-mongo](https://github.com/jdesboeufs/connect-mongo) - MongoDB Session Store
* [compression](https://www.npmjs.com/package/compression) - Route Compression
* [helmet](https://helmetjs.github.io/) - Express Security Headers
* [moment](https://momentjs.com/) - Time/Date Util
* [moment-range](https://github.com/rotaready/moment-range) - Ranges for Moment
* [mobx](https://mobx.js.org/) - Data Store
* [mobx react](https://github.com/mobxjs/mobx-react) - MobX for React
* [passport](http://www.passportjs.org/) - Auth
* [passport-arcgis](http://www.passportjs.org/packages/passport-arcgis/) - Passport for ArcGIS