Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
database
helpers
models
public
routes
.gitignore
README.md
app.js
env.sample
package.json

README.md

Affordable Housing Data Hub

The AffordableHousingDataHub is a web application created as part of a Code for America Community Fellowship in Austin TX. It allows users to access and update an affordable housing database. An instance of this application was deployed for Austin TX so that government agencies and non profits could access and update a single comprehensive source of affordable housing.

Technologies

AffordableHousingDataHub uses node.js on the backend and react.js for the front end. The database configured by default is mysql.

Installation

  1. npm install.
  2. open .env.default and save as '.env' file. By default git will ignore this file under the app folder.
  3. in the '.env' file update the entries
  • NODE_ENV = environment
  • DB_USER = database user name
  • DB_PASSWORD = database user password
  • DB_HOST = host name of mysql server
  • DB_NAME = name of database to use
    • NOTE: MySQL will use internet socket (addr:port) 'localhost' for connections, and port 3306 by default.
    • NOTE: if you get this message: "Client does not support authentication protocol requested by server; consider upgrading MySQL client" - use this sql statment to identify the user with the password: ALTER USER 'root' IDENTIFIED WITH mysql_native_password BY '[your password]'; if you are on windows you may have to use 'root'@'localhost' instead of just 'root'.
  • session_secret = secret text for sessions.
  1. make sure that you have mysql installed on whatever machine is running the app. the version used for this project was version: 8.0.12 MySQL Community Server. if you have to define a scheme or a database name, call it 'AffordableHousingDataHub'

  2. under app/sql you'll find development_db.sql. import this into your sql instance, and it will create / replace with a database called AffordableHousingDataHub. This will contain property data as of 12/18/18. It will also include one user account that you can use for testing. Email is 'test@gmail.com'. Password is 'password'.

  3. create "logs" folder in root directory. add a logfile called "app.log" under the "logs" folder. error logging will be written here.

Adding frontend client

  1. Clone client into project git clone https://github.com/cityofaustin/affordable-housing-data-client client
  2. make sure to update client package.json to have the proxy set to the url of the backend server. eg. "proxy": "http://localhost:3001",

Bringing Everything together

  1. install concurrently gloablly npm install -g concurrently

  2. For Development

  • Start server and client together by running npm/yarn start:dev
You can’t perform that action at this time.