https://github.com/amriteshanand0129/moveinsync
Case Study of MoveInSync : The Carpooling System is a backend-driven ride-sharing platform that connects riders with drivers based on location and user preferences.
https://github.com/amriteshanand0129/moveinsync
express mongodb moveinsync nodejs postman websocket
Last synced: 3 months ago
JSON representation
Case Study of MoveInSync : The Carpooling System is a backend-driven ride-sharing platform that connects riders with drivers based on location and user preferences.
- Host: GitHub
- URL: https://github.com/amriteshanand0129/moveinsync
- Owner: amriteshanand0129
- Created: 2025-02-14T12:59:51.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-18T03:58:33.000Z (about 1 year ago)
- Last Synced: 2025-03-02T23:17:48.455Z (about 1 year ago)
- Topics: express, mongodb, moveinsync, nodejs, postman, websocket
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚗 Carpooling System Backend
This is the **backend server** for the **Carpooling System**, a ride-sharing platform that allows users to find, create, and join rides. The backend is built using **Node.js, Express, MongoDB**, and **WebSockets** for real-time updates.
---
## 📺 **Demo Video**
Watch the full project demonstration here:
🔗 [Video Demo](https://drive.google.com/drive/folders/1TDNILCOFfVENKyc-CCbK3V-lNyYy4pZm?usp=drive_link)
---
## 🚀 **Features**
✅ **User Authentication** (JWT-based authentication)
✅ **Ride Management** (Create, join, and update rides)
✅ **Real-time Ride Updates** (WebSocket integration)
✅ **Ride Matching Algorithm** (Filters rides based on preferences, location proximity, and matching percentage)
✅ **Rider Privacy** (Personal details hidden for other users)
✅ **Emergency SOS Feature** (Notifies family members & authorities with the rider’s location)
---
## 🛠️ **Tech Stack**
- **Backend:** Node.js, Express.js
- **Database:** MongoDB (hosted on Atlas)
- **WebSocket:** `ws` for real-time communication
- **Authentication:** JWT
---
## ⚙️ **Setup & Installation**
### **1️⃣ Clone the Repository**
```sh
git clone https://github.com/amriteshanand0129/MoveInSync
cd backend
```
### **2️⃣ Install Dependencies**
```sh
npm install
```
### **3️⃣ Setup Environment Variables**
Create a .env file in the root directory and add the following:
```sh
PORT = 8080
DB_URL = your_database_url
SECRET = your_jwt_secret
```
### **4️⃣ Start the server**
```sh
npm start
```
The sever will be listening on PORT 8080.
### 🛰️ **API Endpoints** ###
🔗 [View Documentation](https://documenter.getpostman.com/view/33774669/2sAYXEFJSi)