🚌 Where Is My Bus – Real-Time Bus Tracking & Booking System

Revolutionizing Public Transportation with Real-Time Intelligence

🌐 Live Demo • 📖 Documentation • 🚀 Quick Start • 🤝 Contributing

📋 Table of Contents

✨ Overview
🚀 Features
🎯 Target Audience
🛠️ Tech Stack
🏗️ Architecture
📂 Project Structure
⚙️ Installation & Setup
🧪 Usage
📸 Screenshots
🔧 API Documentation
🤝 Contributing
🏆 Contributors
📌 Roadmap
📜 License
⭐ Support
📞 Contact

✨ Overview

Where Is My Bus is a cutting-edge, full-stack web application that transforms the public transportation experience by providing real-time bus tracking, seamless booking, and intelligent route planning. Built with modern technologies and a user-centric design, it empowers commuters with live location data, secure payments, and comprehensive journey management.

Whether you're a daily commuter, a tourist exploring new cities, or a transport operator managing fleets, Where Is My Bus delivers unparalleled visibility and convenience in public transit.

🚀 Features

🔍 Smart Search & Discovery

Multi-criteria Search: Find buses by route (from/to), bus name, or unique ID
Intelligent Filtering: Sort by departure time, price, or availability
Nearby Places Integration: Discover hospitals, schools, and clinics along routes

📍 Real-Time Tracking

Live GPS Monitoring: Track bus locations in real-time on interactive maps
ETA Predictions: Get accurate arrival time estimates
Route Visualization: See complete journey paths with stops and landmarks

🎫 Seamless Booking

One-Click Booking: Instant ticket reservation with secure payment
Multiple Payment Options: Integrated with Razorpay for safe transactions
Booking Management: View, modify, or cancel bookings with ease

🌐 User Experience

Multi-Language Support: Accessible in multiple languages
Responsive Design: Optimized for desktop, tablet, and mobile devices
Dark/Light Mode: Customizable interface for user preference

👤 User Management

Secure Authentication: JWT-based auth with Auth0 integration
Profile Management: Personalized user dashboards
Booking History: Complete transaction and journey records

🔔 Notifications & Alerts

Real-Time Updates: Push notifications for bus arrivals and delays
SMS/Email Alerts: Configurable notification preferences

🤖 AI-Powered Features (Optional)

Smart Route Suggestions: AI-driven optimal path recommendations
Predictive Analytics: Anticipate delays and suggest alternatives

🎯 Target Audience

🚶 Daily Commuters: Students, professionals, and regular travelers
🧳 Tourists & Visitors: Exploring cities with public transport
🏢 Transport Operators: Managing and monitoring bus fleets
🏛️ City Planners: Analyzing transportation patterns
📱 Mobile Users: On-the-go access to transportation information

🛠️ Tech Stack

🎨 Frontend

Technology	Purpose	Version
	UI Framework	18.x
	Build Tool	4.x
	Programming Language	ES6+
	Mapping Service	API v3
	Styling	3.x

⚙️ Backend

Technology	Purpose	Version
	Runtime	18.x
	Web Framework	4.x
	Database	6.x
	Caching	7.x
	Authentication	9.x

🔧 Additional Tools

Technology	Purpose
	Identity Management
	Payment Gateway
	AI Integration
	Real-Time Communication

🏗️ Architecture

graph TB
    A[🌐 Frontend - React/Vite] --> B[🚀 API Gateway - Express.js]
    B --> C[👤 Authentication - Auth0/JWT]
    B --> D[💳 Payment - Razorpay]
    B --> E[📍 Location Services - Google Maps]
    B --> F[🤖 AI Services - OpenAI]

    C --> G[(🗄️ MongoDB)]
    D --> G
    E --> H[(⚡ Redis Cache)]
    F --> H

    I[📡 WebSocket Server] --> A
    I --> J[📱 Mobile Clients]

    K[🚌 GPS Devices] --> L[📊 Tracking Service]
    L --> H
    L --> G

    style A fill:#e1f5fe
    style B fill:#f3e5f5
    style G fill:#e8f5e8
    style H fill:#fff3e0

System Components:

Frontend Layer: Responsive React application with real-time updates
API Layer: RESTful APIs with GraphQL support for complex queries
Data Layer: MongoDB for persistent storage, Redis for caching
Real-Time Layer: WebSocket connections for live tracking
External Services: Integration with payment gateways and mapping services

📂 Project Structure

GPS_Tracker/
├── 📁 Backend/
│   ├── 📁 controllers/          # Business logic handlers
│   ├── 📁 middleware/           # Authentication & validation
│   ├── 📁 models/              # Database schemas
│   ├── 📁 routes/              # API endpoints
│   ├── 📁 services/            # External service integrations
│   ├── 📁 utils/               # Helper functions
│   ├── 📄 server.js            # Application entry point
│   └── 📄 package.json         # Dependencies & scripts
│
├── 📁 Frontend/
│   ├── 📁 src/
│   │   ├── 📁 components/      # Reusable UI components
│   │   ├── 📁 hooks/           # Custom React hooks
│   │   ├── 📁 services/        # API service functions
│   │   ├── 📁 Redux/           # State management
│   │   └── 📄 App.jsx          # Main application component
│   ├── 📄 vite.config.js       # Build configuration
│   └── 📄 package.json         # Dependencies & scripts
│
├── 📁 docs/                    # Documentation
├── 📄 README.md                # Project documentation
├── 📄 API.md                   # API reference
├── 📄 CONTRIBUTING.md          # Contribution guidelines
└── 📄 LICENSE                  # License information

⚙️ Installation & Setup

📋 Prerequisites

Before you begin, ensure you have the following installed:

Node.js (v18 or higher) - Download
MongoDB (v6 or higher) - Download
Redis (v7 or higher) - Download
Git - Download

🚀 Quick Start

Clone the Repository

git clone https://github.com/ayanmanna123/GPS_Tracker.git
cd GPS_Tracker

Environment Setup

# Copy environment templates
cp Backend/.env.example Backend/.env
cp Frontend/.env.example Frontend/.env

Backend Configuration

cd Backend

# Install dependencies
npm install

# Configure environment variables in .env
# See ENV_SETUP.md for detailed configuration

Frontend Configuration

cd ../Frontend

# Install dependencies
npm install

# Configure environment variables in .env

Start Development Servers

# Terminal 1: Start Backend
cd Backend
npm run dev

# Terminal 2: Start Frontend
cd Frontend
npm run dev

Access the Application
- Frontend: http://localhost:5173
- Backend API: http://localhost:5000

🐳 Docker Setup (Alternative)

# Build and run with Docker Compose
docker-compose up --build

🧪 Usage

👤 User Journey

Registration/Login
- Create account or sign in with Auth0
- Complete profile setup
Search & Book
- Search buses by route or location
- Select preferred bus and seat
- Complete secure payment
Track & Travel
- Monitor real-time bus location
- Receive arrival notifications
- Access journey history

🔧 Developer Usage

// Example API usage
import { searchBuses, bookTicket } from './services/api';

// Search buses
const buses = await searchBuses({
  from: 'New York',
  to: 'Boston',
  date: '2024-01-15'
});

// Book a ticket
const booking = await bookTicket({
  busId: 'bus123',
  seats: ['A1', 'A2'],
  paymentMethod: 'razorpay'
});

📸 Screenshots

🏠 Homepage

🗺️ Live Tracking

🎫 Booking Interface

👤 User Dashboard

📝 Note: Replace placeholder images with actual screenshots from your application

🔧 API Documentation

Comprehensive API documentation is available in API.md

🚀 Quick API Reference

# Authentication
POST /api/v1/auth/login
POST /api/v1/auth/register

# Bus Operations
GET /api/v1/buses/search?from=NYC&to=BOS
GET /api/v1/buses/{id}/location

# Booking
POST /api/v1/bookings
GET /api/v1/bookings/{id}

# Real-time Updates
WebSocket: ws://localhost:5000/ws/tracking

For detailed API specifications, see API.md

🤝 Contributing

We welcome contributions from developers of all skill levels! 🚀

📝 How to Contribute

Fork the repository
Clone your fork: git clone https://github.com/your-username/GPS_Tracker.git
Create a feature branch: git checkout -b feature/amazing-feature
Make your changes and test thoroughly
Commit with clear messages: git commit -m "Add amazing feature"
Push to your branch: git push origin feature/amazing-feature
Open a Pull Request

🏷️ Issue Labels

🐛 bug - Bug fixes
✨ feature - New features
📚 documentation - Documentation improvements
🔧 enhancement - Code improvements
🎨 ui/ux - User interface updates
🧪 testing - Test additions/updates

📋 Development Guidelines

Follow ESLint rules
Write comprehensive tests
Update documentation for API changes
Ensure responsive design
Maintain code coverage above 80%

See CONTRIBUTING.md for detailed guidelines.

🏆 Contributors

🌟 Core Team

_{Ayan Manna}
📋 💻

## 🤝 All Contributors

Want to be featured here? Make your first contribution! 🎉

📌 Roadmap

🚀 Phase 1 (Current)

✅ Real-time bus tracking
✅ Secure payment integration
✅ Multi-language support
✅ Responsive web design

🔮 Phase 2 (Q2 2024)

📱 Mobile app development (React Native)
🤖 AI-powered route optimization
📊 Advanced analytics dashboard
🔄 Offline functionality

🚁 Phase 3 (Q4 2024)

🔔 Push notification system
📈 Predictive maintenance alerts
🌍 Multi-city expansion
🤝 Partner integrations

💡 Future Ideas

🏆 Gamification features
🎯 Carbon footprint tracking
🔗 Integration with ride-sharing services
📱 AR navigation assistance

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2024 Ayan Manna

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

⭐ Support

💝 Show Your Support

If you find this project helpful, please consider:

⭐ Starring the repository
🔗 Sharing with your network
💬 Contributing code or documentation
🐛 Reporting issues and suggestions

🆘 Getting Help

📧 Email: support@whereismybus.com
💬 Discussions: GitHub Discussions
🐛 Issues: GitHub Issues
📖 Documentation: Wiki

📞 Contact

Ayan Manna 👨‍💻

Project Link: https://github.com/ayanmanna123/GPS_Tracker

Made with ❤️ by Ayan Manna and the amazing open-source community

Last updated: January 2026

Name		Name	Last commit message	Last commit date
Latest commit History 718 Commits
.github		.github
.vite/deps		.vite/deps
Backend		Backend
Frontend		Frontend
ADMIN_PANEL_README.md		ADMIN_PANEL_README.md
API.md		API.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
ENV_SETUP.md		ENV_SETUP.md
LICENSE		LICENSE
README.md		README.md
TODO.md		TODO.md
WEBSOCKET_SETUP.md		WEBSOCKET_SETUP.md
netlify.toml		netlify.toml
package-lock.json		package-lock.json

License

ayanmanna123/GPS_Tracker

Folders and files

Latest commit

History

Repository files navigation