Skip to Main Content

StayMatch - Open Source Roommate Compatibility Platform

Students and working professionals moving to new cities struggle to find not just accommodation, but compatible roommates. Current methods like brokers, social media groups, or random allocation focus only on room availability and ignore lifestyle compatibility. This often leads to conflicts due to differences in habits, schedules, cleanliness, food preferences, and budget expectations. There is a need for a structured, database-driven platform that integrates accommodation listing with roommate compatibility matching to ensure a smoother and more harmonious shared living experience.

Repository Demo
Team Members
Anshu Gupta
Anshu Gupta
anshu_gupta12
 Vidushi Kansal
Vidushi Kansal
vidushi_kansal
 Happy singh
Happy singh
happy_singh
 Amaan Khan
Amaan Khan
amaan_khan
Description

Nowadays, many students and working professionals move to new cities for studies or jobs. One of the biggest challenges they face is finding a suitable hostel or PG and a roommate who matches their lifestyle. Most people depend on brokers, social media groups, or random roommate allocation. Because of this, they often end up facing problems like lifestyle clashes, cleanliness issues, financial misunderstandings, or differences in daily habits. Right now, there is no proper system that checks whether two people are actually compatible before they share a room. Differences in sleep schedules, smoking or drinking habits, food preferences, and budget expectations can easily lead to conflicts. This project aims to make this process more organized and reliable by creating a web-based platform that stores user preferences and calculates compatibility between roommates. By using a structured database system, the platform can manage data properly and suggest better matches, helping users avoid unnecessary conflicts and have a smoother accommodation experience.

Deployment (video set as unlisted) - https://www.youtube.com/watch?v=HAQ2HPi6gWs

Current Solution

Currently, people find roommates using:

  • Local brokers

  • Social media groups

  • Word-of-mouth referrals

  • Random hostel allocation

  • Rental listing platforms

These methods consider only:

  • Vacancy availability

  • Gender

  • Budget

  • Basic preferences

They do not evaluate lifestyle compatibility, which leads to conflicts after roommates start living together.

System Features

StayMatch provides intelligent, AI-driven features to enable compatibility-based roommate matching and reduce conflicts in shared living environments.

🧠 Core Features

  • Lifestyle Compatibility Matching

    Evaluates users based on lifestyle parameters such as sleep cycle, cleanliness, noise tolerance, and social behavior to generate compatibility insights.

  • Conflict Risk Prediction Engine

    Predicts potential roommate conflicts using rule-based analysis and categorizes matches into Low, Medium, and High Risk.

  • Smart Chore Allocation System

    AI-based chore distribution using:

    • Difficulty weighting

    • Cleanliness preference balancing

    • Weekly rotation system

    • Fairness score calculation

  • Agreement Architect (Auto Contract Generator)

    Automatically generates structured roommate agreements based on:

    • Rent details

    • Rules & responsibilities

    • Lifestyle preferences

📊 Visualization & Insights

  • Workload Distribution Visualization

Interactive Pie Chart (Chart.js) showing chore distribution between roommates.

  • Fairness Meter

Displays balance in workload assignment with dynamic visual feedback.

  • Final Match Verdict System

    Combines:

    • Compatibility Score

    • Conflict Risk

    • Chore Fairness

      → to generate a final recommendation:

    • Ideal Match

    • Good Match

    • Not Recommended

⚡User Experience Features

  • Interactive Dashboard UI (Bento Grid Design)

    Modern glassmorphism-based dashboard for seamless navigation.

  • Typewriter AI Feedback System

    Dynamic AI-generated outputs with real-time typing animation.

  • Downloadable Outputs

Users can download:

  • Agreements

  • Chore Plans

  • Local Storage-Based Session Handling

    Maintains user state without complex backend auth flow.

🔧 Functional Features

  • REST API Backend Integration Modular API system for:

    • Matching

    • Conflict prediction

    • Agreement generation

    • Chore allocation

  • Extensible Rule-Based Engine Easily upgradable to ML-based models in future.

Technology Stack

Frontend

  • HTML5

  • CSS3

  • JavaScript (ES6)

  • Chart.js

Backend

  • Node.js

  • Express.js

Database

  • MongoDB (for storing user data & preferences)

  • Mongoose (schema & data modeling)

Authentication

  • JSON Web Tokens (JWT)

  • bcrypt.js

Development Tools

  • Visual Studio Code

  • Git & GitHub

  • Postman

Project Outcomes

  • Open-source compatibility engine

  • Configurable roommate matching system

  • Conflict risk prediction

  • Transparent compatibility scoring

  • Digital roommate agreements

  • Visual compatibility analytics

  • Smart roommate recommendation system

  • Modular and scalable architecture

Repositary Link

Issues & PRs Board
No issues or pull requests added.