Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 53 additions & 74 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# SafarMitra

SafarMitra is a taxi pooling app designed to make travel more affordable and convenient for college students. It allows users to create and join rooms based on a shared start location and destination, helping them find fellow passengers to split taxi fares efficiently. By connecting students heading in the same direction, SafarMitra promotes cost-effective and hassle-free travel.

## 🎯 Who is it for?

SafarMitra is exclusively designed for college students who want to share taxis for daily commutes, reducing travel costs while ensuring a comfortable and secure ride.


<h1 align="center">
<a href="https://github.com/CommunityOfCoders/Inheritance-2024">
<img src="./Untitled.png" alt="CoC Inheritance 2024" width="500" height="166">
</a>
<br>
Project Name
</h1>

<div align="center">
//project name
</div>
<hr>

<details>
<summary>Table of Contents</summary>

- [Description](#description)
- [Links](#links)
- [Tech Stack](#tech-stack)
- [Progress](#progress)
- [Future Scope](#future-scope)
Expand All @@ -24,91 +28,72 @@ SafarMitra is exclusively designed for college students who want to share taxis

</details>

## 📝Description



## 🔗Links

- [GitHub Repository](https://github.com/)
- [Demo Video]()
- [Drive Link to Screenshots of your project]()
- [Hosted Website Link]()
- [Hosted Backend Link]()



## 🤖Tech-Stack

Mention all languages/libraries/frameworks used in your project **domain-wise**
You can use icons too - find them [here](https://github.com/get-icon/geticon)
Mention all languages/libraries/frameworks used in your project **domain-wise**
You can use icons too - find them [here](https://github.com/get-icon/geticon)

#### Front-end

- React
- Tailwind
- HTML
- CSS
- JavaScript
- MaterialUI
- React
- etc.

#### Back-end

- NodeJS
- ExpressJS
- Multer
- Socket IO
- Google maps API
- JWT
-
- etc.

#### Database

- MongoDB
- etc.

## 📈Progress
#### nlp
-Ml

- **Car Pooling System** 🚕 – Allows users heading toward the same route to share taxis.
- **Real-time Location Updates** 📍 – Implemented using **Socket.io**.
- **File Upload Handling** 📂 – Managed using **Multer**.
- **Authentication & Authorization** 🔐 – Secured with **JWT tokens**.
- **User Profile Management** 👤 – Enables users to manage their profiles.
- **Driver Profile Management** 🚖 – Allows drivers to manage their details.
- **Live Location on Map** 🗺️ – Implemented for tracking users and taxis.
- **History Tracking** 📜 – Tracks rooms and earnings for both users and drivers.
- **User and Driver Earnings** 💰 – Displays cumulative earnings based on completed rides.
- **Open/Closed Room Mechanism** 🔄 – Users can open or close rooms to control ride availability.
- **Ratings for Users and Drivers** ⭐ – Allows both users and drivers to rate each other for better quality control and trust.
## 📈Progress

## 🔮 Future Scope
List down all the fully implemented features in your project

As SafarMitra evolves, several exciting features will be introduced to enhance user experience and security:

- **RWallet (SafarMitra Wallet)** 💳 – A built-in digital wallet for seamless payments, eliminating cash dependency.
- **Truecaller-Like Spam Reporting** 🚨 – Users can report and flag suspicious or unreliable drivers to ensure a safer ride-sharing experience.
- **Automated Ride Matching** 🔄 – AI-driven recommendations for better ride-pooling suggestions based on user preferences and travel history.
- **Driver & Passenger Ratings** ⭐ – A rating and review system to help users choose reliable ride partners.
- **Live Ride Tracking** 📍 – Real-time location sharing for enhanced safety and convenience.
- **College Verification System** 🎓 – Ensuring only verified college students can join, enhancing security and trust within the community.

Stay tuned for more updates as we continue to improve SafarMitra! 🚀
List down all the partially implemented features in your project

## 🌍 Applications of SafarMitra
## 🔮Future Scope

SafarMitra offers a range of practical applications, making travel easier and more efficient for college students:

- **🚕 Cost-Effective Travel** – Helps students save money by sharing taxi fares with others traveling on the same route.
- **🎓 Campus Commuting** – Ideal for students commuting between college, hostels, and home, reducing travel expenses.
- **📍 Smart Ride Coordination** – Enables users to create and join ride rooms, ensuring quick and efficient taxi pooling.
- **🛡️ Enhanced Safety** – Restricts access to verified college students, ensuring a secure ride-sharing environment.
- **🚀 Time-Saving** – Reduces waiting time by quickly matching passengers heading in the same direction.
- **🌱 Eco-Friendly Travel** – Promotes shared rides, reducing traffic congestion and carbon footprint.
- **📱 Digital Convenience** – Provides a seamless, user-friendly interface for easy ride management.
## 💸Applications

SafarMitra is designed to **enhance mobility, improve affordability, and ensure safety** for students relying on taxis for daily travel! 🚖✨

## 🛠Project Setup

For the Web-App 1.Clone the GitHub repo.

```bash
git clone <url>
```

2.Enter the client directory. Install all the required dependencies.

```bash
cd frontend
npm install
npm start
```

3.To start the backend server:4

```bash
cd backend
npm install
Expand All @@ -119,27 +104,21 @@ git clone <url>

Add names of your team members with their emails and links to their GitHub accounts

- [Yogesh Palve ](https://github.com/Yogesh-Palve) :([email protected])
- [Chaitanya Shinde ](https://github.com/Chaitanya-666): ([email protected])
- [Sahil Waje ](https://github.com/sahilwaje23):([email protected])
- [Ritesh Saindane ](https://github.com/Ritesh-Saindane):([email protected])
- [Team Member 1 ](https://github.com/)
- [Team Member 2 ](https://github.com/)
- [Team Member 2 ](https://github.com/)
- [Team Member 2 ](https://github.com/)

## 👨‍🏫Mentors

Inheritance Mentors for SafarMitra
Add names of your mentors with their emails and links to their GitHub accounts

- [Vedant Kale ](https://github.com/Manav39):
- [Manav Shah](https://github.com/VedantKale08):
- [Mentor 1 ]()):
- [Mentor 2 ]():

## 📱Screenshots

![alt text](image.png)
![alt text](image-1.png)
![alt text](image-2.png)
![alt text](image-3.png)
![alt text](image-4.png)
![alt text](image-5.png)
![alt text](image-7.png)
![alt text](image-8.png)
![alt text](image-9.png)
![alt text](image-10.png)

![Screenshot alt text]( "screenshot")