diff options
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/README.adoc b/README.adoc index ae788c8..3893c81 100644 --- a/README.adoc +++ b/README.adoc @@ -1,9 +1,9 @@ -= Housing selector -:description: Documentation for the project += Living space +:description: Documentation for the Living space :sectanchors: :url-repo: https://git.tammi.cc/housing.git -SVG and WGS94 https://www.w3.org/TR/SVG11/coords.html +SVG and WGS84 https://www.w3.org/TR/SVG11/coords.html The project consists of three parts: @@ -11,7 +11,7 @@ The project consists of three parts: 2. CouchDB and S3 3. Scraper (Golang) -The developments tools are listed in flake.nix and development environment can be start with command: +The developments tools are listed in flake.nix. The development environment can be start with command: [source,bash] ---- @@ -25,7 +25,7 @@ The application resides in app directory. [%header,format=tsv] |=== -include::app/requirements.tsv[] +include::./app/requirements.tsv[] |=== Run (the development server) with: @@ -35,16 +35,17 @@ Run (the development server) with: node server.js ---- -Static assets are deployed to web server. +Static assets are deployed directly to a web server with Git. +Later it could be possible to download the assets to CounchDB. == Scraper runner -Golang is used to fetch the data to CouchDB. +Golang implementation fetches the data to CouchDB. The runner resides in scrape directory. [%header,format=tsv] |=== -include::scrape/requirements.tsv[] +include::./scrape/requirements.tsv[] |=== The running will require some cookies to be gotten from a web browser. Run with: @@ -66,9 +67,9 @@ go run main.go - Make the weight calculation work. - Fix the map zoom and initial viewport - Add links to house details on the service. Add additional images -- Parse more data from data source. Now only overview is parsed. +- Parse more data from data source. Currently only overview is parsed. - Images on modal open on click to a new window -- Visual programming? Value function description with javascript? +- Visual programming? Value function description with Javascript? - Notifications to user on new houses - Sharing via URL - Real support for MultiLineString in geometry @@ -81,7 +82,7 @@ https://kartta.hel.fi/avoindata/dokumentit/Aineistolista_wfs_avoindata.html WFS Capabilities can be found from: https://kartta.hel.fi/ws/geoserver/avoindata/wfs?version=2.0.0&request=GetCapabilities -The data can then be downloaded with CURL. +The data can then be downloaded with CURL. Examples below: === Roads [source,bash] |