README.md

GovEx Housing Affordability

This is not a full Django project, just an app to be included in an existing project. Visit this project here

Setup and Installation

1. Download (probably within a virtual environment used for an existing project):

pip install git+https://github.com/govex/housing_affordability.git

2. Add to INSTALLED_APP of the Django Project settings module:

# djangoproj/settings.py

INSTALLED_APPS = [
...
'housing_affordability',
...
]

3. Add to Django Project urls module:

# djangoproj/urls.py

urlpatterns = [
...
path('analysis/housing/', include('housing_affordability.urls')),
...
]

4. Add a link to your template where ever appropriate (possibly a nav bar) that links to /analysis/housing/.

5. Set up database (or use existing project database) and run migrations.

6. Populate database: python manage.py load_housing_govs and python manage.py load_housing_demos

TODO:

1. Continue to add, improve, and explain visualizations and UI/UX.
2. Clean up css which has a lot of unnecessary stuff because it was mostly grabbed from a different project.
3. If possible, set up URLs in templates to be robust to prefix from Project URLs (eg /analysis/housing in setup step 3)
4. Expand set up step 5 to explain database setup
5. Update requirements in setup.py. The existing ones are a first guess and there may be more.
6. Expand TODO