/RoomMateMatcher

Helps match with a roommate in your area

Primary LanguageJavaScript

ROOMMATE MATCHER

The Roommate Matcher project is a user-friendly web application built for the Web Development React course. This application aims to help users find compatible roommates based on their preferences and lifestyle.

Table of Contents

Setup

  • Create Auth0 Account

    • Follow the link to create Auth0 account for developers. Start at Configure React with Auth0.
  • Get a Google Maps API key from google
    • Create a free account
    • Click the donut on the top left
    • Click on the Google Maps Platform
    • Select keys & Credentials to create an API key
    • Restrict the API key as needed
  • Now fork/clone the github repo here!

Frontend

  1. Navigate to the /frontend directory in your terminal. 
    cd frontend
  2. Create a .env file in the frontend directory 
    VITE_GOOGLE_MAPS_API="GOOGLE MAPS API KEY"

VITE_AUTH0_DOMAIN="AUTH0 DOMAIN"
VITE_AUTH0_CLIENT_ID="AUTH0 CLIENT ID"
VITE_AUTH0_CALLBACK_URL="AUTH0 CALLBACK URL"
  3. Install dependencies 
    npm install
  4. Start the development server 
    npm run dev
  5. Open your web browser and navigate to http://localhost:5173 to view the application.

Backend

  1. On another terminal, navigate to the /backend directory in your terminal. 
    cd backend
  2. Install dependencies 
    npm install
  3. Start the development server 
    npm start
  4. Backend Server run on http://localhost:8003

For more information on how to set up the backend, please refer to the backend/readme file.