README.md

Roomatch

This project allows people to easily find roomates by Connecting you with potential roommates based on shared interests, lifestyle preferences, and location.🔍 Put the doom scrolling to use and find a decent roommate for your upcoming semester.👫

Table of Contents

• Features
• Demo
• Getting Started using docker
• Tech stack

Features

• Use AWS S3 for secure profile management and image storage.
• Recommendation System: Implement a preference-based engine to deliver personalized suggestions.
• Match Interaction: Facilitate seamless viewing and connection with potential matches.
• Secure Authentication: Employ Firebase Authentication for robust and secure user sign-up and login.
• CI/CD with GitHub Actions: Implemented using GitHub Actions to automate and streamline the development workflow.
• Docker: Utilized Docker to simplify installation and ensure consistent development environments for all devs.

Demo

Roomatch.mp4

Getting Started

Set up

Thanks to docker this is simple:

1. Clone the repo

git clone https://github.com/preetgami/roomatch
cd roomatch

2. Run the following

cd frontend
cp sample.env .env
cd ..
cd backend
cp sample.env .env
cd ..

3. Supply the env vars.

• For frontend you require firebase auth .
• For backend you require a Mongodb collection and an aws s3 bucket .

4. Finaly run

docker compose up

Tech stack

• Vue3
• mongoDb
• Node.js
• AWS S3
• Github Actions
• Firebase Auth
• Docker