Skip to content

Latest commit

 

History

History
94 lines (66 loc) · 2.52 KB

README.md

File metadata and controls

94 lines (66 loc) · 2.52 KB
Raw

Real-Time Tracker

Real-Time Tracker is a web application designed to provide a seamless tracking experience similar to Zomato's rider tracking feature. It offers real-time location updates and an intuitive map view, ensuring user can monitor rider effortlessly.

Features

  • Real-Time Location Updates: Track the live location of riders personnel.
  • Interactive Map View: Visualize delivery routes using OpenStreetMap and Leaflet.
  • User Authentication: Separate login/signup pages for users and delivery personnel.
  • Marker Management: Users can create and manage markers on the map.

Technologies Used

  • Frontend: React, React-Leaflet, React Router
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Mapping: Leaflet, OpenStreetMap

Installation

To run this project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/exclusiveabhi/real-time-tracker.git
cd real-time-tracker

  2. Install dependencies:

    npm install

  3. Set up MongoDB:

    • Create a MongoDB database and obtain your connection string.

    • Update the MongoDB URI in .env file:

      MONGODB_URI=your_mongodb_connection_string

  4. Start the development server:

    npm start

  5. Open your browser and navigate to http://localhost:3000.

Folder Structure

real-time-tracker/
├── client/         # Frontend React app
│   ├── public/
│   └── src/
│       ├── components/
│       ├── pages/
│       ├── App.js
│       ├── index.js
│       └── ...
├── server/         # Backend Node.js app
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── app.js
│   └── ...
├── .env            # Environment variables
├── package.json    # Project dependencies and scripts
└── README.md       # Project overview, installation guide, and usage instructions

Usage

  • User Interface: Navigate to the login/signup pages for users and delivery personnel.
  • Map View: View real-time location updates and delivery routes on the map.

Contributing

Contributions are welcome! Fork the repository and submit a pull request with your changes.

License

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

Acknowledgments

  • Leaflet: Open-source JavaScript library for mobile-friendly interactive maps.
  • OpenStreetMap: Open data mapping service.

Happy Coding!