Skip to content

SJSUSpring21/LiveBetter

Repository files navigation

LiveBetter

House Scoring Project - Approved

Introduction

The house scoring project aims at generating a unique score for every house. The score is calculated by taking into consideration the livability index of the location as well as other economic,social and demographic factors.The generated scroe can in turn help people make informed choices while buying or renting homes.

Abstract

The motivation of this project is to help home buyers or renters make an informed decision before they choose a place to live. There are many factors that play into deciding where to live. A given location should fit a persons needs and lifestyle. The goal of this project is to consider common factors that contributes to a person's decision on choosing a house.

Approach

Input: What information are we going to get from the user?

Location Preference: Address

Process:

The various factors taken into consideration to analyze livability includes natural environments, economic prosperity, social stability and equity, educational opportunity, cultural, entertainment and recreation possibilities.

Examples : Schools, gyms, hospitals, supermarkets, outdoor recreation centers,etc

Output: What will the output be for our users?

Livability score within the range of 1 - 10

A brief overview of services nearby: "This location has 3 schools, 1 gym, 20 parks."

Persona

Our target audience will be individuals looking to buy or rent a home/apartment. This will help users make an informed decision.

Architecture Diagram

Diagram

Tech Stack

  • Frontend: React, HTML, CSS, Bootsrap

  • Backend: Node.js, Express

  • Database: MongoDB, IBM DB2

  • Preprocess Data: Python

  • APIs: Google Autocomplete, Google Places API

Dataset Links

Build Project

  1. In backend/.env.dist include your own Google API Key by setting the variable GOOGLE_API_KEY to your own key.
  2. Change the file name of backend/.env.dist to backend/.env
  3. In the root directory, run the command docker-compose up --build
  4. Go to http://localhost:3000 to see project