/vtransport

Primary LanguageJavaScript

Getting Started with VTransport App

Introduction

VTransport is an optimized webapp, a one way solution for all related functionalitites of Transportation Department of Vellore Institute of Technology, Chennai. It is designed to address the needs of individuals to avoid early morning hastles. Leveraging the advancements in internet technology, VTransport aims to deliver daily routine bus schedule with all the necessary details in one app. Which also consist of tracking of the route which the bus is travelling for new college transportaion. This README file provides a comprehensive guide to using VTransport, outlining its features, functionalities, and how to get started.

VTransport offers a range of features to provide accessible transportation related solutions:

Feature Description
Important Updates Helps users to be notified at the earliest on any important, urgently required news which needs to be delivered to students or faculties.
Transport Helpline Students and bus users are given acces to helpline number in case of any issues.
Schedule Facilitates daily schedule, displays bus timing for each stop, filters according to timing whichever bus route no. is available at that particular time.
General Information Users can choose their bus no. Provides comprehensive information on bus transport incharge, bus route no. and various other details.
Tracking System Offers static map which displays the route for each bus, also personalized bus route displaying specific path alone taken by the bus

Installation

To use VTransport, follow these steps:

cd backend

npm i

node server.js

cd ..

npm i

npm run dev

Runs the app in the development mode.
Open http://localhost:5173 to view it in your browser.

How to Contribute

Contributions to this project are always welcome! If you would like to contribute, please follow these steps:

  1. Fork the repository
  2. Clone the repository to your local machine
  3. Create a new branch for your feature or bug fix
  4. Make your changes and commit them with descriptive commit messages
  5. Push your changes to your fork
  6. Create a pull request to the main repository