Greyisheep / rent-predictor

This is a project to help tech newbies get started with open source by building
GNU Lesser General Public License v2.1
5 stars 5 forks source link

[ENQUIRY] What will the FastAPI server look like? #18

Open collinsezedike opened 1 year ago

collinsezedike commented 1 year ago

I took a course recently on how to contribute to open source and my tutor recommended that I ask the code maintainer questions before building concrete castles on a watery bed. Before 46eb86f, I assumed that the API would return house data as json. The house data json would then be rendered on the front-end probably as cards showing different houses and how their features correspond with their prices. I was already working on this.

I am suffering the consequences of my naivety but I have repented of my sins. What exactly should the backend API look like?

Greyisheep commented 1 year ago

Hello @collinsezedike thanks for the detailed question. The initial and main purpose of this project is house price prediction, Currently, the API should(as already set up) collect features of a property as a json from the front-end, run the make_predictions, and pass the predicted rent price back to the front-end.

For future improvements, I want to design a search algorithm, that does collaborative filtering, but like how you suggested it. So, all the houses will display on the front-end, and when searching, will filter to suite the search.

collinsezedike commented 1 year ago
  1. Will there be a REST API with CRUD operations for housing data?
  2. Should the search function not be handled from the frontend (for speed)?
Greyisheep commented 1 year ago

Yes, have you checked out the API I already built yet?

Please, check it out first