a_adli/colouring-montreal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Ed Chalstrey 2022-02-24 11:17:31 +00:00
parent c3f76fad7b
commit 4b23232717
1 changed files with 8 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -26,26 +26,16 @@ for download under a liberal open data license
## Setup and run ## Setup and run
1. Provision database (see [migrations](migrations/README.md)) 1. Test the application:
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`
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).
_Last updated 24th February 2022_
2. Create a production version of the application:
```bash We also have documentation on setting up a production environment here: [docs/setup-production-environment](docs/setup-production-environment.md).
APP_COOKIE_SECRET=test_secret \
PGHOST=localhost \ _Last updated 24th December 2021_
PGUSER=dbuser \
PGDATABASE=dbname \
PGPASSWORD=dbpassword \
PGPORT=5432 \
TILECACHE_PATH=/path/to/tilecache/directory \
npm start
```
[Provision script](provision/vm_provision.sh) can be also of interest.
## Acknowledgements ## Acknowledgements