Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
phyeony authored Dec 20, 2022
1 parent 903177a commit e76fefc
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Backend
# Intro
Welcome to Airbnb finder. Find your best Airbnb when you travel to Metro Vancouver.
![image](https://user-images.githubusercontent.com/67985232/208594362-64b92dbd-cedb-4b4b-a8f2-a3316b85c32e.png)

# 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 FastApi: `pip install "fastapi[all]"`
3.  Install pandas: `pip install pandas`
2.  Install Dependencies: `pip install -r requirements.txt`

**To run**
1.  `cd backend`
Expand All @@ -18,9 +22,8 @@ Remember to edit the request body which the api endpoint will receive.
An example request body json:
```
{
"airbnb_price_range": [
0, 400
],
"min_price": 0,
"max_price": 400,
"airbnb_room_type": [
"Room A", "Room B"
],
Expand All @@ -33,8 +36,7 @@ An example request body json:

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


# Frontend
## Frontend

**Dependencies** (Only needs to do the first time and when new library is added)
1.  Use node 18
Expand Down

0 comments on commit e76fefc

Please sign in to comment.