Update README notes
This commit is contained in:
parent
4422be4440
commit
dad023a7c5
15
README.md
15
README.md
@ -18,20 +18,19 @@ This repository will contain open-source code for the project which:
|
|||||||
- allows site visitors to download the collected building attribute data
|
- allows site visitors to download the collected building attribute data
|
||||||
|
|
||||||
Building attribute data collected as part of the project will be made available
|
Building attribute data collected as part of the project will be made available
|
||||||
for download under a liberal open data license (likely ODbL).
|
for download under a liberal open data license (
|
||||||
|
[ODbL](https://opendatacommons.org/licenses/odbl/1.0/)).
|
||||||
|
|
||||||
## Setup and run
|
## Setup and run
|
||||||
|
|
||||||
1. Provision database (see `migrations`)
|
1. Provision database (see `migrations`)
|
||||||
1. Install apps/dependencies (`npm i`)
|
|
||||||
1. Load buildings and geometries to database (see `etl`)
|
|
||||||
1. Fill out details in `config.json` (see `config.template.json`)
|
1. Fill out details in `config.json` (see `config.template.json`)
|
||||||
1. Run express apps:
|
1. Load buildings and geometries to database (see `etl`)
|
||||||
- tileserver `PGHOST={host} node index.js`
|
1. Install app dependencies: `cd app && npm i`
|
||||||
- apiserver `PGHOST={host} node index.js`
|
1. Run tests: `npm test`
|
||||||
- frontend `http-server -a localhost -p 8080`
|
1. Run app: `npm start`
|
||||||
|
|
||||||
## A note from our sponsors
|
## Acknowledgements
|
||||||
|
|
||||||
Colouring London is being designed and built by the Centre for Advanced Spatial
|
Colouring London is being designed and built by the Centre for Advanced Spatial
|
||||||
Analysis (CASA), University College London and funded by Historic England.
|
Analysis (CASA), University College London and funded by Historic England.
|
||||||
|
Loading…
Reference in New Issue
Block a user