BunkBuddies

Web application for finding roomates during VIT hostel counselling


Visit · Report Bug · Request Feature

About The Project

BunkBuddies is a web application developed by VinnovateIT that helps in selecting roommate for VIT hostel counseling. It leverages Natural Language Processing to generate compatibility scores and rank potential roommates. It features private and public chats to facilitate seamless communication between VIT students.

Screenshots

Dashboard	Create Room
Explore Rooms	Chat

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Before you begin, ensure you have the following installed on your system:

• Python (3.8 or higher): Required to run the backend and NLP compatibility models.
• MongoDB: A local installation or an active MongoDB Atlas URI for the database.
• Git: For cloning the repository and version control.
• A modern web browser (Chrome, Edge, Firefox, etc.).

Installation

1. Clone the repo

   git clone https://github.com/vinnovateit/BunkBuddies-Backend.git

2. Install the required libraries using the requirements.txt

   pip install -r requirements.txt

3. Go to MongoDB Atlas and create a cluster and get a connection string URL for it and store it in the .env file

   MONGODB_URI = YOUR-CONNECTION-URL-HERE

4. Go to Google Cloud Console and get a Google client ID and the secret key for it and store them in the .env file

   GOOGLE_CLIENT_ID = YOUR-GOOGLE-CLIENT-ID-HERE
   GOOGLE_CLIENT_SECRET = YOUR-GOOGLE-SECRET-KEY-HERE

5. Enter your full gmail address in mail username and mail from and Go to Google Security Settings and generate a 16 letter App Password and store it in the .env file

   MAIL_USERNAME = your_mail@gmail.com
   MAIL_FROM = your_mail@gmail.com
   MAIL_PASSWORD = 16-Letter-App-Password

6. Go to Hugging Face and generate a token API Key and store it in .env file

   HUGGINGFACE_API_KEY = hf-your-long-token-here

Usage

BunkBuddies uses natural language processing to match you with the most compatible roommates based on your living habits, schedules, and lifestyle preferences. It streamlines the hostel counseling experience by allowing you to filter rooms by specific blocks and ac prefrences. It also verifies student credentials and facilitates secure in-app messaging, allowing you to connect confidently before making a final decision.

Top contributors:

Acknowledgments

• VinnovateIT Family for mentoring and resources
• A huge thank you to the open-source community behind the core stack: FastAPI & Pydantic (Backend), Motor/PyMongo (Database), WebSockets (Real-time features), and Authlib/PyJWT (Security).

Made with ❤️ by VinnovateIT