In our project, we will explore housing market data from Zillow. This data will be hosted on an AWS RDS instance running Postgresql.
Flask is used as the API backend serving the data, and React.js is used to render the frontend (with yarn as its package manager). ChartJS is used to render the plots.
Database Connection: To connect to the postgreSQL database, you will need to create a file named .env
inside the react-flask-app/api
directory. Populate this file with the following keys:
DATABASE_ENDPOINT=
DATABASE_PORT=
DATABASE_NAME=
DATABASE_USER=
DATABASE_PASSWORD=
Please talk to one of the group members to get the values for these keys. They are not provided here for security reasons.
To run the app locally, follow these steps after cloning the repository to your local machine and entering the directory:
- Ensure that you have all required Python packages installed -
pip install -r requirements.txt
- Navigate to the app directory -
cd react-flask-app
- Start the backend (Flask) -
yarn start-api
a. Check the connection to the database by visitinglocalhost:5000/checkdbconnection
- Start the frontend (ReactJS) -
yarn start
- Navigate to app in browser at
localhost:3000/