A full-stack Uber clone project built using React for the frontend and Node.js for the backend. The project includes various functionalities such as user authentication, ride requests, and payment integration. All APIs and React components have been created, but the map integration is pending due to map service charges.
- User Authentication: Secure sign-in and sign-up functionality for drivers and riders.
- Driver and Rider Management: Users can register as either a rider or a driver.
- Trip Management: Riders can request rides, and drivers can accept or reject ride requests.
- Ride Status: Real-time updates on ride status, including pickup and drop-off locations.
- Payment Integration: Basic payment system using Stripe (or a similar service) for fare calculation and transactions.
- Notifications: Push notifications for ride status updates.
- Frontend: React.js, React Router, Redux
- Backend: Node.js, Express.js, MongoDB
- Authentication: JWT (JSON Web Tokens)
- Payment Gateway: Stripe (or similar service)
- State Management: Redux
- APIs: Custom-built APIs for ride management, driver management, authentication, and payment.
- Map Integration: The map feature for displaying real-time ride routes is not integrated yet due to the associated costs of using map services (Google Maps, Mapbox). However, the backend API structure is ready for integration when the map service is available.
To set up the project locally:
- Clone the repository:
https://github.com/harshustle/Uber-Website cd Uber-Website
API Documentation Auth API POST /auth/register: Register a new user (driver or rider).
POST /auth/login: Login to your account and receive a JWT token for authentication.
Ride API POST /rides/request: Request a ride as a rider.
POST /rides/accept: Accept a ride as a driver.
POST /rides/complete: Complete a ride as a driver.
Driver API GET /drivers/:id: Get details of a driver.
PUT /drivers/:id: Update driver details.
Payment API POST /payment/charge: Process a payment for a completed ride.
Future Improvements Map Integration: Integrate Google Maps or Mapbox to show real-time ride routes and locations.
UI/UX Enhancements: Improve the user interface and overall user experience.
Ride History: Implement a feature to show ride history for both riders and drivers.
Real-Time Chat: Add a chat feature for communication between riders and drivers.
License This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments Google Maps/Mapbox (for future integration).
Stripe for payment gateway integration.
Various open-source libraries used in the project.
- Introduction: Describes the project and its features.
- Technologies Used: Lists the technologies and tools involved.
- Setup Instructions: Provides clear instructions to set up the backend and frontend locally.
- API Documentation: Describes the backend API endpoints that are available.
- Future Improvements: Mentions what features are pending (like map integration) and possible future enhancements.
- License: You can modify the license as needed.
This README template will give other developers or users an understanding of your project, how to set it up, and what to expect from the Uber clone. Let me know if you'd like further adjustments!