Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contact
4. Additional Resources

About The Project

Live Link

Haus is a Zillow inspired website with frontend and backend support for home listings and tour scheduling. Favorites, offers and other features are still in development.

Listings

Browse homes for sale across the United States

List a home for sale and easily manage your listing

Tours

Book a tour for any home you are interested in purchasing and manage your tour

Built With

• React
• Flask
• Postgres
• SQLAlchemy
• React Google Maps

(back to top)

Getting Started

Installation

Backend

1. Clone this repository

   git clone https://github.com/eulloa10/houseme-project

2. Install dependencies

   pipenv install -r requirements.txt

3. Sign up for a Google Developer API key if you don't have one already. This will be necessary for the Google Maps feature to work.

4. Create a .env file based on the example with proper settings for your development environment

5. Make sure the SQLite3 database connection URL is in the .env file

6. Get into your pipenv, migrate your database, seed your database, and run your Flask app

   pipenv shell

   flask db upgrade

   flask seed all

   flask run

Frontend

1. Navigate to the react-app folder and npm install

   cd react-app
   npm install

2. Start the React app

   npm start

(back to top)

Contact

• Edgar Ulloa

(back to top)

Additional Resources

• Flask-SQLAlchemy Quick Reference
• AWS S3 Reference
• React Google Maps
• Google Maps Platform

(back to top)