Skip to content

ayush0521/vibe-roommate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🏠 Vibe Roommate

A compatibility-first roommate matching platform for college students
focused on lifestyle alignment, reduced conflicts, and better shared living.


📌 Project Overview

Vibe Roommate is a full-stack web application designed to solve one of the most common yet overlooked problems in student housing: roommate incompatibility.

Unlike traditional housing platforms that prioritize rent and location, this system introduces a behavior-based matching approach using a structured vibe quiz and compatibility scoring.


🎯 Problem Statement

  • Roommate conflicts arise due to lifestyle mismatches (not just rent or location)
  • Students frequently change accommodations due to incompatibility
  • Existing platforms lack structured compatibility evaluation

This project treats roommate matching as a behavioral compatibility problem rather than a purely real-estate problem.


🧠 Core Concept

The system collects user preferences through a structured Vibe Quiz, including:

  • Sleep schedule
  • Cleanliness level
  • Noise tolerance
  • Study habits
  • Social behavior

Based on responses, the system generates:

  • Vibe badges (user personality indicators)
  • Compatibility score between users

Matching is rule-based and explainable to ensure transparency.


👥 Target Users

  • College students looking for compatible roommates
  • Students with available rooms/beds
  • PG/hostel providers targeting student users

⚙️ Core Features

  • User authentication (Register / Login)
  • Vibe quiz for lifestyle profiling
  • Badge generation system
  • Compatibility matching engine
  • Room listings module
  • Basic messaging system

🔍 Matching Logic

Compatibility is calculated using a simple rule-based approach:

Match Score = (Matching Preferences / Total Preferences) × 100
  • 90–100% → Perfect Match
  • 70–89% → Good Match
  • 50–69% → Moderate Match
  • Below 50% → Risky Match

🏗️ System Architecture

Frontend (React)
        ↓
Backend (Node.js + Express)
        ↓
Database (MongoDB)
        ↓
Matching & Badge Services

🛠️ Tech Stack

  • Frontend: React.js
  • Backend: Node.js + Express.js
  • Database: MongoDB
  • Authentication: JWT-based login system
  • API Communication: Axios

📂 Project Structure

vibe-roommate/
│
├── frontend/
│   └── src/
│       ├── pages/
│       ├── components/
│       ├── services/
│       ├── App.js
│       └── index.js
│
├── backend/
│   ├── models/
│   ├── routes/
│   ├── controllers/
│   ├── services/
│   ├── config/
│   └── server.js
│
├── docs/
│   ├── diagrams/
│   └── reports/
│
├── README.md
└── .gitignore

🚧 Development Status

Currently in early development phase (MVP stage)

  • Project structure initialized
  • Core modules planned (Auth, Quiz, Matching)
  • Backend and frontend setup in progress

🚀 Roadmap

  • 15%: Authentication + Quiz + Basic Matching
  • 30%: Listings + Messaging + Dashboard
  • 50%: Improved UI + Filters + Profile System
  • 100%: Full integration + polished system + deployment

🤝 Contribution

  • Frontend development (React)
  • Backend APIs (Node.js)
  • Database schema design
  • Matching logic improvements
  • UI/UX enhancements

📄 License

This project is licensed under the MIT License.


Built by Ayush Padmawar

About

College-centric roommate and student housing platform using lifestyle-based compatibility matching.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors