You can find the deployed project at https://www.letscarpal.com/.
| Carl Redding | Ruth Poliakon | Steven Vandenburg | Darren Angus |
|---|---|---|---|
 |
 |
 |
 |
| Dang Lu | Lesley Banadzem | Daniel Martin | Dennis Padiernos |
|---|---|---|---|
 |
 |
 |
 |
Carpals is a app that safely connects communities and commuters going in the same direction living in the same area to save money, reduce environmental & infrastructural impact by CarPalling.
Karen has a 40-mile commute in Los Angeles, which equates to a 90-minute drive each way. Karen is burning through her money and beating up her car. She'd really love to carpool with someone who lives near her, but she doesn't know how or where or how to meet them.
Someone who cares about traffic
Someone who does not have reliable transport and need to carpool.
Someone who cares about the environment.
Karen is not making enough to finance her commute. The wear and tear on her car and the rising cost of gas is bankrupting her.
- Problem 1 - People spend money on their cars and gas in long and rough stop and go commutes. All the while wear and tear adds up on their cars.
- Problem 2 - Environmental impact of cars on the road
- Problem 3 - Lack of current transportation/car
- Problem 4 - Person concerned with impact on aging US infrastructure
- Problem 5 - Stressed out by commute
- Problem 6 - Wants to Meet People
- Problem 7 - Karen scored a DUI and still needs to get to work
To safely connect communities and commuters going in the same direction living in the same area to save money, reduce environmental & infrastructural impact by CarPalling.
- Signup and Login
- Signup and Login using Google Account [via PassportJS]
- Signout
- Create and Update Profile
- Upload Profile Picture
- Save Favorite Locations (Such as Home and Work) [Via Mapbox]
- Request a Ride
- Accept or Reject Ride Requests
- Text Alerts to Riders [via Twilio]
- Driver Arrival ETA
- Ad hoc ride requests
- Displays Route for Driver
- Sends text through Twilio to the Rider to Alert them that a Ride is Coming
- Show, Add, & Edit Favorite Locations
- Show, Add, & Start a Ride
- Payment System [via Stripe]
- Driver/passenger ratings
- Friends list
- Chat
- Mobile native app
- Gamification (user stats/point system)
- Driver real time location
- Safety features (user verification)
- React was choosen due to its ability to setup a SPA efficiently and in a scalable manner.
- Formik
- Axios
- Redux
- Yup
- Sass
- Jest
- Router
Back end built using:
- Node and Express enable the setup of servers and DBs that support the Carpals app
- Node and Express also allow the team to utilize Javascript across the stack
- Postgres enable the carpals app to build a persistent and scalable SQL DB
- React
- AWS
- Axios
- PassportJS
- Twilio
- Mapbox
In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:
* REACT_APP_MAPBOX_TOKEN - API Token to Utilize Mapbox
* REACT_APP_IS_STAGING - Set equal to 1 in order for axios to properly interface with the appropriate backend environment
For Front-end testing we're using React Testing Library(RTL) & Jest to perform testing of our components. RTL comes packed with a suite of tests.
We're also using code-climate (run as part of our CI/CD process) to determine test coverage and code maintainability.
Yup has been setup for form validation
Use 'npm install' to install all necessary dependencies
* build - creates a build of the application
* start - starts the production server after a build is created; if used locally, creates a local instance of a server at localhost:3000
* eject - used to modify CRA dependencies
* coverage - runs a test coverage report that is displayed at the top of this readme
* test - runs tests in **tests** directory
If you're interested in contributing to this project, please email us at labs.pt.carpal@gmail.com or DMing us on Twitter @carpaling
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.