Travel Buddy

Helping IIT KGP students find travel partners for their trips
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Installation
3. Usage
4. Contributing
5. Roadmap
6. Maintainer(s)
7. Contact

About The Project

Travel Buddy is a NextJS 14 and MongoDB Atlas-based web application designed to help IIT KGP students find travel partners for various trips. Whether it's sharing a cab to the airport, finding a train buddy, or coordinating travel plans, Travel Buddy makes it easier to connect with fellow travelers.

Features

• Trip Matching: Enter your trip details and find others with similar plans within a +/-3 hour window.
• Train Matching: Enter your train details to find other travelers on the same train and date.
• High Usability: Easy-to-use interface designed specifically for IIT KGP students.
• Authentication: Secure login and registration using Institure Email Address using heimdall.

(back to top)

Installation

To set up Travel Buddy locally, follow these steps:

Prerequisites

• Ensure you have Node.js and npm installed. You can download them from here.
• MongoDB Atlas account and cluster. Sign up here.

Steps

1. Clone the repository:

   git clone https://github.com/metakgp/travel-buddy.git
   cd travel-buddy

2. Install the dependencies:

   npm install

3. Configure environment variables:

   • Create a .env file in the root directory.

   • Add your MongoDB Atlas connection string:

     MONGODB_URI=your_mongodb_connection_string

   • Add your JWT secret key:

     JWT_SECRET=your_jwt_secret_key

4. Run the application:

   npm run dev

(back to top)

Usage

To use Travel Buddy, follow these steps:

1. Open the application in your browser:

   http://localhost:3000

2. Register or log in using your Institute Email Address.

3. Enter your trip or train details to find matching travelers.

4. Browse through the list of potential travel partners and connect with them.

Matching Logic

• Trip Matching: Finds other travelers with trip times within +/- 3 hours of your specified time.
• Train Matching: Matches travelers based on the train number and departure date.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Steps to Contribute

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Development Setup

• Ensure your development environment is set up with Node.js, npm, and MongoDB Atlas.
• Refer to the Installation section for initial setup instructions.

(back to top)

Roadmap

• UI and Quality of Life (QOL) improvements.
• Enhance train matching logic to include nearby arrival/departure timings at the same station.
• Adapt the application for use by other colleges.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Maintainer(s)

• Saharsh Agrawal

(back to top)

Contact

📫 Metakgp -

(back to top)