diff --git a/README.md b/README.md index bed4e19..5815982 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,17 @@ -

- - CoC Inheritance 2024 - -
- Project Name -

- -
- //project name -
-
+# 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. + +
Table of Contents - [Description](#description) -- [Links](#links) - [Tech Stack](#tech-stack) - [Progress](#progress) - [Future Scope](#future-scope) @@ -28,65 +24,83 @@
-## ๐Ÿ“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 -- HTML -- CSS -- JavaScript + - React -- etc. +- Tailwind +- JavaScript +- MaterialUI #### Back-end + - NodeJS - ExpressJS -- etc. +- Multer +- Socket IO +- Google maps API +- JWT +- #### Database -- MongoDB -- etc. -#### nlp --Ml +- MongoDB ## ๐Ÿ“ˆProgress -List down all the fully implemented features in your project +- **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. + +## ๐Ÿ”ฎ Future Scope +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. -List down all the partially implemented features in your project +Stay tuned for more updates as we continue to improve SafarMitra! ๐Ÿš€ -## ๐Ÿ”ฎFuture Scope +## ๐ŸŒ Applications of SafarMitra +SafarMitra offers a range of practical applications, making travel easier and more efficient for college students: -## ๐Ÿ’ธApplications +- **๐Ÿš• 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. +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 ``` + 2.Enter the client directory. Install all the required dependencies. + ```bash cd frontend npm install @@ -94,6 +108,7 @@ git clone ``` 3.To start the backend server:4 + ```bash cd backend npm install @@ -104,21 +119,27 @@ git clone Add names of your team members with their emails and links to their GitHub accounts -- [Team Member 1 ](https://github.com/) -- [Team Member 2 ](https://github.com/) -- [Team Member 2 ](https://github.com/) -- [Team Member 2 ](https://github.com/) +- [Yogesh Palve ](https://github.com/Yogesh-Palve) :(yogesh.palve.clg@gmail.com) +- [Chaitanya Shinde ](https://github.com/Chaitanya-666): (orionck545@gmail.com) +- [Sahil Waje ](https://github.com/sahilwaje23):(sahilwaje645@gmail.com) +- [Ritesh Saindane ](https://github.com/Ritesh-Saindane):(ritesh.saindane.st@gmail.com) ## ๐Ÿ‘จโ€๐ŸซMentors -Add names of your mentors with their emails and links to their GitHub accounts +Inheritance Mentors for SafarMitra -- [Mentor 1 ]()): -- [Mentor 2 ](): +- [Vedant Kale ](https://github.com/Manav39): +- [Manav Shah](https://github.com/VedantKale08): ## ๐Ÿ“ฑScreenshots - -![Screenshot alt text]( "screenshot") - - +![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)