🚗 Saarthi

Your Journey, Our Priority

A modern ride-sharing platform connecting riders with drivers

---

✨ Features

👥 User Experience 🔐 Secure Authentication - JWT-based login system 📱 Responsive Design - Works on all devices 🎨 Modern UI - Beautiful Tailwind CSS interface ⚡ Real-time Updates - Live ride tracking

🚙 Driver Management 👨‍✈️ Captain Profiles - Comprehensive driver information 🚗 Vehicle Management - Car details and status 📍 Location Tracking - Real-time positioning 💼 Earnings Dashboard - Revenue tracking

🛡️ Security & Performance

Feature	Technology	Status
🔒 Password Hashing	bcrypt	✅ Active
🎫 Authentication	JWT Tokens	✅ Active
🌐 API Security	CORS + Validation	✅ Active
📊 Database	MongoDB + Mongoose	✅ Active

🏗️ Project Structure

Saarthi/
├── Backend/                 # Node.js/Express API server
│   ├── controllers/         # Route controllers
│   ├── models/             # MongoDB data models
│   ├── routes/             # API routes
│   ├── services/           # Business logic
│   ├── middlewares/        # Custom middleware
│   └── db/                 # Database configuration
├── Frontend/               # React application
│   ├── src/                # Source code
│   ├── public/             # Static assets
│   └── package.json        # Frontend dependencies
└── README.md              # Project documentation

🚀 Tech Stack

🖥️ Backend Technology Purpose Version 🟢 Node.js Runtime Environment Latest 🚀 Express.js Web Framework ^4.21.2 🍃 MongoDB Database ^8.9.3 🎫 JWT Authentication ^9.0.2 🔐 bcrypt Password Hashing ^5.1.1

🎨 Frontend Technology Purpose Version ⚛️ React UI Library ^19.0.0 ⚡ Vite Build Tool Latest 🎨 Tailwind CSS Styling ^4.1.3 🎬 GSAP Animations ^3.13.0 🌐 Axios HTTP Client ^1.8.4

📋 Prerequisites

Before running this project, make sure you have:

• Node.js (v16 or higher)
• npm or yarn
• MongoDB (local installation or MongoDB Atlas)
• Git

⚡ Quick Start Guide

Get Saarthi running in just 4 simple steps!

🔥 Step 1: Clone the Repository

# Clone the project
git clone https://github.com/your-username/Saarthi.git
cd Saarthi

🔧 Step 2: Backend Setup

# Navigate to backend directory
cd Backend

# Install dependencies
npm install

Create .env file in Backend directory:

# Server Configuration
PORT=3000

# Database Configuration
MONGODB_URI=mongodb://localhost:27017/saarthi

# Security
JWT_SECRET=your_super_secret_jwt_key_here

Start the backend server:

npm start

✅ Backend running on: http://localhost:3000

🎨 Step 3: Frontend Setup

# Navigate to frontend directory
cd ../Frontend

# Install dependencies
npm install

Create .env file in Frontend directory:

# API Configuration
VITE_API_URL=http://localhost:3000

Start the development server:

npm run dev

✅ Frontend running on: http://localhost:5173

🎉 Step 4: Access Your Application

Service	URL	Status
🌐 Frontend	http://localhost:5173	🟢 Ready
🔌 Backend API	http://localhost:3000	🟢 Ready

---

🚀 You're all set! Start building amazing rides!

🔧 Available Scripts

Backend

• npm start - Start the production server
• npm run dev - Start development server with nodemon
• npm test - Run tests

Frontend

• npm run dev - Start development server
• npm run build - Build for production
• npm run preview - Preview production build
• npm run lint - Run ESLint

📚 API Endpoints

Authentication

• POST /users/register - Register a new user
• POST /users/login - User login
• POST /captains/register - Register a new captain (driver)
• POST /captains/login - Captain login

User Management

• GET /users/profile - Get user profile
• PUT /users/profile - Update user profile
• POST /users/logout - User logout

Captain Management

• GET /captains/profile - Get captain profile
• PUT /captains/profile - Update captain profile
• POST /captains/logout - Captain logout

🗃️ Database Models

User Model

• Personal information (firstName, lastName)
• Email and password
• Authentication methods

Captain Model

• Personal information (firstName, lastName)
• Email and password
• Vehicle information
• Location data
• Status (available/busy)

🛡️ Security Features

• Password Hashing - Using bcrypt for secure password storage
• JWT Authentication - Stateless authentication with JSON Web Tokens
• Input Validation - Server-side validation using express-validator
• CORS Protection - Configured for secure cross-origin requests

🎨 UI/UX Features

• Responsive Design - Mobile-first approach with Tailwind CSS
• Smooth Animations - GSAP-powered transitions and effects
• Modern Interface - Clean and intuitive user experience
• Bootstrap Icons - Comprehensive icon library

🚀 Deployment

Backend Deployment

1. Set up environment variables on your hosting platform
2. Configure MongoDB connection string
3. Deploy to platforms like Heroku, Railway, or DigitalOcean

Frontend Deployment

1. Build the project: npm run build
2. Deploy the dist folder to platforms like Netlify, Vercel, or GitHub Pages

🤝 Contributing

We love contributions! Here's how you can help make Saarthi even better.

🍴 Fork # Fork the repo git fork

🌿 Branch # Create feature branch git checkout -b feature/amazing-feature

📝 Commit # Commit changes git commit -m 'Add amazing feature'

🚀 Submit Pull Request

1. Push your branch: git push origin feature/amazing-feature
2. Open a Pull Request with a clear description
3. Wait for review and feedback
4. Celebrate your contribution! 🎉

---

💡 Ideas for contributions:

• 🐛 Bug fixes
• ✨ New features
• 📚 Documentation improvements
• 🎨 UI/UX enhancements
• 🧪 Test coverage

📝 License

This project is licensed under the ISC License.

👥 Meet the Team

Suyash 🚀 Creator & Lead Developer

---

🙏 Acknowledgments

🌟 Inspiration Modern ride-sharing platforms

💻 Built With Love, coffee, and code

🤝 Community Thanks to all contributors

---

📞 Get in Touch

🎉 Happy Coding! Let's build the future of transportation together! 🚗💨