rushilwiz/wheelshare-frontend
1
0
Fork 0
mirror of https://github.com/myfatemi04/wheelshare-frontend.git synced 2025-04-16 09:00:17 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'main' of https://github.com/myfatemi04/Carpool-Frontend into main

Browse Source
This commit is contained in:
Michael Fatemi 2021-04-11 15:05:51 -04:00
commit b96c6a4a60
1 changed files with 15 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
README.md
View File

@ -1,70 +1,23 @@
# Getting Started with Create React App
# WheelShare
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
By Michael Fatemi, Rushil Umaretiya, Joshua Hsueh, Nitin Kanchinadam
## Available Scripts
(Frontend Repository created with Create React App)
In the project directory, you can run:
## Inspiration
At TJ, many people are spread around several counties, and transportation becomes a difficult problem. It’s hard to communicate and organize groups for carpooling, and many after-school activities do not offer transportation to go back home. One of our members, Rushil, has a daily commute of about 1 hour and 45 minutes, and he also participates in quite a few sports and extracurriculars. It's always been a struggle to find people who live nearby who commute around the same times, wasting not only gas but parents time as well. We needed a solution to easily connect different people going to different places, so why don't we share?
### `yarn start`
## What it does
WheelShare allows users to easily and safely organize carpools with other people. Each user can create or join groups with other people. For example, an user could join a group for students at their school or for their little league baseball team. Within each group, users can post requests or offers for carpools that other members of the group can look at. Users can then look at the waypoints for each pool in the group and easily register for the pool that would be most convenient for them. All members of a pool can then interact with each other to further coordinate pick up and drop off using the built-in comments and chat features.
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## How we built it
We built this web application with the MERN stack (MongoDB, ExpressJS, ReactJS, NodeJS). We decided to implement this stack with Typescript. We also utilized Material UI to style all our components. We implement the Google Maps API and React Google Maps libraries to suggest locations based on the search text as well as display the set addresses on a map.
The page will reload if you make edits.\
You will also see any lint errors in the console.
## Accomplishments that we're proud of
We are proud of integrating the Google Maps API with React and implementing groups, posts, comments, users, and authentication on a serverless setup. To create the WheelShare API, develop the frontend, and give it a good user experience, required a lot of teamwork and collaboration and it was great to be able to pull it off. Some of our members were not familiar with the frameworks we were using, but as we worked together, we were all comfortable with them.
### `yarn test`
## What we learned
A lot of us were inexperienced with TypeScript and JavaScript frameworks in general. However, with team collaboration and dedication we were able to persevere and learn how to apply Typescript and React efficiently. We also learned a lot about integrating the various features of the Google Maps API with ReactJS.
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `yarn build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `yarn eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `yarn build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
## What's next for WheelShare
Although WheelShare provides the capability for users to join pools and groups, currently, the only way for members of a pool to communicate with each other is through the comments of the pool. This method of communication is also available to all people in the group and not just exclusive to the members of the pool. Therefore, one of the next features to be implemented is a group chat features for members of each pool. In addition, we will bring the app to React Native and add different OAuth endpoints to enable sign-in from a variety of places such as GitHub and Google rather than just the TJ Intranet.