update README
This commit is contained in:
parent
c3f76fad7b
commit
4b23232717
24
README.md
24
README.md
@ -26,26 +26,16 @@ for download under a liberal open data license
|
||||
|
||||
## Setup and run
|
||||
|
||||
1. Provision database (see [migrations](migrations/README.md))
|
||||
1. Load buildings and geometries to database (see [etl](etl/README.md))
|
||||
1. Install app dependencies: `cd app && npm i`
|
||||
1. Run tests: `npm test`
|
||||
1. Run app: `npm start`
|
||||
1. Test the application:
|
||||
|
||||
In development, run with environment variables:
|
||||
You can try out the Colouring London application by setting up your own development environment, which includes the option to load test data from OpenStreetMaps (OSM). See [docs/setup-dev-environment](docs/setup-dev-environment.md).
|
||||
|
||||
```bash
|
||||
APP_COOKIE_SECRET=test_secret \
|
||||
PGHOST=localhost \
|
||||
PGUSER=dbuser \
|
||||
PGDATABASE=dbname \
|
||||
PGPASSWORD=dbpassword \
|
||||
PGPORT=5432 \
|
||||
TILECACHE_PATH=/path/to/tilecache/directory \
|
||||
npm start
|
||||
```
|
||||
_Last updated 24th February 2022_
|
||||
2. Create a production version of the application:
|
||||
|
||||
[Provision script](provision/vm_provision.sh) can be also of interest.
|
||||
We also have documentation on setting up a production environment here: [docs/setup-production-environment](docs/setup-production-environment.md).
|
||||
|
||||
_Last updated 24th December 2021_
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user