Uber Clone is an Application that allows Riders to Request for a ride.
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of NodeJs and Yarn/npm Installed
- You have a
<Windows/Linux/Mac>machine. State which OS is supported/which is not. - You have read
<guide/link/documentation_related_to_project>.
To install <project_name>, follow these steps:
Linux and macOS:
yarn install
Windows:
yarn install
create .env file add the below.
DB_USERNAME=
DB_PASSWORD=
DB_HOST=
SENDGRID_API_KEY=
TWILIO_SID=
TWILIO_TOKEN=
TWILIO_PHONE=
JWT_KEY=
To use <project_name>, follow these steps:
<usage_example>
Add run commands and examples you think users will find useful. Provide an options reference for bonus points!
- Sign In / Sign Up with Facebook
- Sign In with Email
- Start Phone Number Verification
- Complete Phone Number Verification
- Sign Up with Email
- Generate JWT
- Verify JWT
- Get my Profile
- Request Email Verification
- Complete Email Verification
- Update my Profile
- Toggle Driving Mode
- Report Location / Orientation
- Add Place
- Edit Place
- Delete Place
- Get My Places
- See Nearby Drivers
- Subscribe to Nearby Drivers
- Request a Ride
- Get Nearby Ride Requests
- Subscribe to Nearby Ride Requests
- Update Ride Status
- Get Ride
- Subscribe to Ride Status
- Create a Chat Room
- Get Chat Room Messages
- Send a Chat Message
- Subscribe to Chat Room Messages
- Get Ride History
- See Ride Detail
To contribute to <project_name>, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>. - Make your changes and commit them: `git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>/<location> - Create the pull request.
Alternatively see the GitHub documentation on creating a pull request.
Thanks to the following people who have contributed to this project:
You might want to consider using something like the All Contributors specification and its emoji key.
If you want to contact me you can reach me at your_email@address.com.
This project uses the following license: <license_name>.