Welcome Page
Login Page
Sign up Page
Questionnaire Portion
Home Page
Nav Menu
Roommate Matching
Chat Page
Friend System Page
Request Guide Page
Profile Page

BoilerMates

BoilerMates is a roommate matching application designed to help Purdue students find compatible roommates, and as the (superior) option for finding roommates at Purdue!

It was created as part of the 2025 Boilermake Hackathon at Purdue University.

Our main inspiration for this project stems from a combination of the current housing crises at Purdue, the pain and frustration that the roommate questionnaire forms, and the overall difficulty of finding a good roommate going into college. With BoilerMates, we hope to be able to alleviate a part of the issue, by providing a user-friendly, convenient, and tailored platform, to make this part of the college experience that much easier.

Features

User Authentication: Secure sign-up and login using Firebase Authentication.
Profile Management: Create and update your profile with personal details and living preferences.
Roommate Matching: Find compatible roommates based on mutual preferences and habits.
Chat & Friend Management: Connect with potential roommates via real-time chat, send friend requests, and manage blocked users.
User Questionnaire Extensive user questionnaire used to gauge the best potential matches in roommates.

Tech Stack

React for the front-end
Firebase (Authentication, Firestore Database)
React Router for navigation
Xenova all-MiniLM for Natural Language Processing (NLP) of user's questionnaire data

Prerequisites

Node.js (v14+ recommended)
npm
A Firebase project configured with Firestore and Authentication enabled
Xenova all-MiniLM for NLP

Installation Steps

Fork, then clone the repository
install the mentioned dependencies via npm install
Run the program with cd .\boiler-mate\ && npm start
Enjoy :)

File structure

boilermates/
├─ public/
│   └─ index.html
│   └─ manifest.json
│   └─ logo.svg
│   └─ robots.txt
├─ src/
│   ├─ components/
│   ├─ pages/
│   │   ├─ Home.js
│   │   ├─ Profile.js
│   │   ├─ Friends.js
│   │   └─ ...
│   ├─ css/
│   │   ├─ home.css
│   │   ├─ chat.css
│   │   └─ ...
│   ├─ firebaseConfig.js
│   ├─ App.js
│   └─ index.js
├─ package.json
└─ README.md

We hope you enjoy!