README.md

Intro

Welcome to Airbnb finder. Find your best Airbnb when you travel to Metro Vancouver.

Algorithm

Gathered data from OSM using Panda and PySpark. Then scored Airbnbs depending on the distance from these attractions for each category. For more details, please refer the attached pdf report. https://github.com/phyeony/airbnb-finder/blob/master/CMPT%20353%20Report.pdf

To run Locally

Backend

Dependencies (Only needs to do the first time and when new library is added)

1.  Use python 3.10 (Below should work but I'm using 3.10)
2.  Install Dependencies: pip install -r requirements.txt

To run

1.  cd backend
2.  python3 main.py

To call the endpoint

Use provided swagger UI when you run the app. You can access it here; http://localhost:8000/docs or more specifically; http://127.0.0.1:8000/docs#/airbnb/get_airbnb_list_api_airbnb_list_post

Remember to edit the request body which the api endpoint will receive.

An example request body json:

{
  "min_price": 0,
  "max_price": 400,
  "airbnb_room_type": [
    "Room A", "Room B"
  ],
  "amenity_preference": [
    "Food", "Transportation"
  ]
} 

Note:

The logic for our airbnb computation will live in backend/src/airbnb_service.py. The cleaned_data will live in backend/cleaned_data.

Frontend

Dependencies (Only needs to do the first time and when new library is added)

1.  Use node 18
2.   cd frontend
3.   npm install

To run

1.  cd frontend (If you haven't already)
2.  npm start

You can check it out at http://localhost:3000