aliijaz1997 / Map-Proximity

Ride App: Your all-in-one solution for hassle-free ride booking and driver connectivity, featuring real-time communication and multiple user roles.

Ride App (React & Google Maps Javascript API )

• 
• 
• 
• 
• 
• 
• 
• 

The Ride App is a comprehensive ride-sharing platform that allows users to book rides, connect with drivers, and manage the service efficiently. It caters to three distinct roles: Customers, Drivers, and Admins, each with their unique set of features.

Table of Contents

• Features
• Technologies
• Getting Started
• Installation

Features

• User Roles:

  • Customer: Book rides, manage bookings, and track rides.
  • Driver: Accept ride requests, update availability, and view ride details.
  • Admin: Manage users, rides, and system configurations.

• Real-time Communication: Utilizes Firebase and Pusher for seamless real-time updates.

• Frontend:

  • Built with React for a dynamic user interface.
  • Styled using Tailwind CSS for responsive design.
  • State management with Redux Toolkit.
  • Data fetching with RTK Query for efficient API interactions.

• Backend:

  • Developed with Express.js.
  • Database powered by MongoDB for scalability.
  • Firebase integration for authentication.

• Convenient Start Scripts:

  • Use a common package.json at the root.
  • Start both frontend and backend with a single command: npm run watch.
  • Easy dependency installation: npm install.

Getting Started

To get started with the Ride App, follow these steps:

1. Clone the repository to your local machine.
2. Install the necessary dependencies using npm install.
3. Set up Firebase and MongoDB configurations.
4. Run the app using npm run watch.

For detailed instructions, refer to the Installation and Usage sections.

Installation

You can install the project's dependencies by running the following command at the root of the project:

npm install && npm run watch