Skip to content

Latest commit

 

History

History
68 lines (38 loc) · 3.45 KB

README.md

File metadata and controls

68 lines (38 loc) · 3.45 KB
Raw

SaveMyJourney - README

Table of Contents

  1. Introduction
  2. Demo
  3. Description
  4. Features
  5. Tech Stack
  6. Getting Started
  7. Usage
  8. Contributing

1. Introduction

Welcome to the SaveMyJourney GitHub repository! SaveMyJourney is a safety application designed for travelers, with a focus on passengers using cabs and rickshaws. The primary objective of this application is to enhance the interaction between drivers and passengers through a unique QR code system. Passengers can easily scan the QR code, enter their source and destination, and track their ride in real-time. SaveMyJourney also includes a feature for unregistered cabs to address potential safety concerns.

⚠️ Declaration: Some of the UI components, such as the header and login functionality, have been reused from previous projects. The remainder of the application was developed during this hackathon.

2. Demo

You can watch a video demo of SaveMyJourney by following this link: SaveMyJourney Demo

3. Description

In the video demo, our team, Optimizers 404, introduces you to SaveMyJourney and explains its features and functionalities. SaveMyJourney aims to make travel safer and more convenient for passengers using cabs and rickshaws. The application streamlines the interaction between drivers and passengers through the use of unique QR codes for registered cabs. Passengers can scan these QR codes, input their source and destination, and monitor their ride in real-time. Additionally, the app provides a solution for unregistered cabs to address potential issues.

4. Features

  • Unique QR Codes: SaveMyJourney generates a unique QR code for each registered cab, making it easy for passengers to identify their ride.

  • Real-Time Tracking: Passengers can track their journey in real-time, ensuring a safer and more transparent travel experience.

  • Source and Destination Input: Users can input their source and destination within the app, providing drivers with essential information.

  • Safety for Unregistered Cabs: The application includes features to address safety concerns with unregistered cabs.

5. Tech Stack

SaveMyJourney is built using the following technologies:

  • MERN Stack (MongoDB, Express, React, Node.js) for the development of the web application.

  • Google Maps API for real-time location tracking and mapping functionalities.

6. Getting Started

To get started with SaveMyJourney, follow these steps:

  1. Clone this repository to your local machine.

  2. Set up the necessary environment variables, such as API keys for Google Maps integration.

  3. Install the required dependencies by running npm install in the client and server directories.

  4. Start the server by running npm start in the server directory.

  5. Start the client by running npm start in the client directory.

7. Usage

After setting up the application, you can start using SaveMyJourney to enhance your travel experience. Register and log in as a passenger or driver to take advantage of the unique features provided.

8. Contributing

We welcome contributions from the community to make SaveMyJourney even better. If you have any feature suggestions, bug reports, or would like to contribute code, please create a pull request or issue on this repository.