Skip to content

Roommate Finder is a responsive web application designed to help users easily find and connect with potential roommates. Users can browse available listings, view detailed roommate profiles, and manage their own listings with options to add, update, or delete. The app features secure user authentication using Firebase and supports both light and da

Notifications You must be signed in to change notification settings

mdshakibsami/Roommate-Finder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Roommate Finder - Client Side

A web application to help users find and connect with potential roommates.

Features

  • Browse available roommate listings
  • View detailed roommate information
  • Add new roommate listings
  • Update and delete listings
  • User authentication with Firebase
  • Light/Dark theme toggle with smooth transition
  • Responsive design for all devices

Technology Used

  • React 18 with Vite
  • Tailwind CSS with DaisyUI
  • Firebase Authentication
  • MongoDB (through server API)
  • Express.js (backend)

Package Dependencies

  • React Router: For page navigation
  • React Simple Typewriter: Used in Banner component for text animation
  • React Icons: For various icons throughout the app
  • Swiper: For image slider in Banner component
  • Firebase: For user authentication
  • React-tooltip: For tooltip

Pages

  • Home (with Banner, Features, How it Works sections)
  • Browse Listings
  • Add Roommate
  • My Listings
  • Listing Details
  • Login/Register
  • Update Listing

Project Structure

src/
├── components/     # Banner, Navbar components
├── contexts/      # Theme and Auth contexts
├── firebase/      # Firebase configuration
├── hooks/         # Custom hooks
├── layouts/       # Root layout
├── pages/         # All page components
└── provider/      # Auth and Private route providers

Getting Started

  1. Install dependencies
npm install
  1. Set up Firebase configuration in .env
VITE_FIREBASE_API_KEY=your_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_domain
VITE_FIREBASE_PROJECT_ID=your_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
VITE_FIREBASE_APP_ID=your_app_id
  1. Run the development server
npm run dev

About

Roommate Finder is a responsive web application designed to help users easily find and connect with potential roommates. Users can browse available listings, view detailed roommate profiles, and manage their own listings with options to add, update, or delete. The app features secure user authentication using Firebase and supports both light and da

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages