🎓🏠 UniRoomMatess: Your Ultimate Roommate Finder in Canada! 🇨🇦

Welcome to UniRoomMatess! The one-stop platform making it a breeze for international students in Canada to find the perfect roommate. Whether you're an undergrad, grad student, or pursuing your PhD, we've got you covered! Connect, share living spaces, and dive into local communities with friends who share your interests. 🌟

---

✨ Key Features

• Personalized Profiles: Craft a detailed profile highlighting your personal and study habits, plus your interests, to match with the most compatible roommates! 📝💡

• Secure Authentication: Experience a safe login process with our unique key system, ensuring your data stays protected. 🔑🔒

• Explore Roommates: Browse through potential roommate cards on the home page and discover your ideal living partner at a glance! 👀🤝

• Join Groups: Form or join groups based on shared interests or needs, and keep the conversation going with integrated email communication. 📧👥

• Discover Local Events: Check out upcoming events in Windsor and get involved in the community. Make memories together! 🎉📅

---

💻 Technologies Used

• Frontend: Built with React and Vite for a lightning-fast, seamless user experience. ⚛️⚡

• Backend: Powered by Express on Node.js, handling all your requests efficiently. 🚀🛠️

• Database: Utilizes MongoDB for flexible and secure data storage. 🗄️🔐

• Authentication: Implements a unique key-based system to manage user sessions and secure API endpoints. 🛡️🔑

---

🚀 Installation & Setup

Prerequisites

• Node.js 🟩
• MongoDB 🍃
• Git (optional, for cloning the repository) 🐙

Steps to Get Started

1. Clone the Repository 📥

   git clone https://github.com/your-username/UniRoomMatess.git
   cd UniRoomMatess

2. Install Dependencies 📦

   Backend:

   cd backend
   npm install

   Frontend:

   cd ../frontend
   npm install

3. Configure Environment Variables 🛠️

   Create a .env file in the backend directory and add your configurations (e.g., database URI, JWT secret).

4. Start the Application 🎬

   Backend Server:

   cd backend
   npm start

   Frontend Server:

   cd ../frontend
   npm run dev

5. Launch the App 🌐

   Open your browser and navigate to http://localhost:5173 to start exploring UniRoomMatess!

---

🏁 Getting Started

• Register: Sign up to create your profile and unlock all features. 📝
• Login: Access your account securely using the credentials you registered with. 🔐
• Explore: Dive into the home page to find potential roommates, join groups, and check out local events! 🎉

---

🤝 Contribution

We love contributions! Whether it's a bug fix, new feature, or documentation improvement, your help is welcome. Please refer to the CONTRIBUTING.md file for more details on how to contribute to this project. Let's make UniRoomMatess even better together! 🌟

---

📝 License

This project is licensed under the MIT License. Feel free to use, modify, and distribute it as you wish! 📄

---

Connect • Share • Live 🏡✨

Join UniRoomMatess today and start your journey towards finding the perfect roommate in Canada!