https://github.com/davidje13/househunt

Extra filtering capabilities & visualisations on third-party UK property data
https://github.com/davidje13/househunt

Last synced: about 1 month ago
JSON representation

Extra filtering capabilities & visualisations on third-party UK property data

• Host: GitHub
• URL: https://github.com/davidje13/househunt
• Owner: davidje13
• Created: 2021-01-05T13:08:07.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-07T01:53:45.000Z (almost 4 years ago)
• Last Synced: 2024-10-20T02:39:33.482Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 54.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# House Hunt

Loads data from property APIs (currently Zoopla) and provides enhanced filtering options.

Requires a PostgreSQL database to connect to:

```sh

psql postgres -c 'CREATE DATABASE house_hunt;'

```

And a Zoopla API key (see  to register).

For all the following commands, if you used an alternative database name

or a remote database, you can specify the connection string explicitly:

```sh

DB_URL=postgresql://localhost:5432/house_hunt whatever-command-here

```

## Loading data

This command will connect to the property API and load or refresh data:

```sh

ZOOPLA_KEY=my-key-here ./src/load/index.mjs

```

This may take several hours to complete due to API rate limits.

The process can be stopped and restarted at any time.

Once you have loaded new data, you should apply processing (this is much faster).

```sh

./src/process/index.mjs

```

You do not need to wait for all the data to load to run this command, and it

can be run repeatedly as more data is loaded.

## Running

Once you have loaded some data, you can start the application:

```sh

./src/start/index.mjs

```