Browse Source

add readme

fzadrazil 5 years ago
parent
commit
ca8099eea1
1 changed files with 20 additions and 0 deletions
  1. 20 0
      README.md

+ 20 - 0
README.md

@@ -0,0 +1,20 @@
+# Rural Attractivness back-end service
+
+After the update of source data, refresh the service cache
+GET https://publish.lesprojekt.cz/nodejs/refresh
+
+List of all the datasets
+GET https://publish.lesprojekt.cz/nodejs/datasets
+
+Attractivity data for the region with ID equal to the 'nuts' parameter
+GET https://publish.lesprojekt.cz/nodejs/scores/{nuts}
+
+Attractivity data for all the regions in source CSV data
+GET https://publish.lesprojekt.cz/nodejs/scores
+
+Computes and returns attractivity data for all the NUTS regions based on the incomming datasets and factor weights
+POST https://publish.lesprojekt.cz/nodejs/scores
+
+
+Start the system service
+sudo systemctl start fz-node-rural_attractiveness