Commit 8e51e86b authored by Niklas Callsen's avatar Niklas Callsen

add further usage documentation

parent 96818445
# Usage
# Live-Demo
The demo can be found at [](
# Setup
## Docker setup
The root folder contains a `docker-compose.yml`. Since [all configuration should be done via environment variables](
you can define all necessary URLs and ports in `docker-compose.yml`.
......@@ -25,18 +27,20 @@ curl -XPUT localhost:9200/family2coords -H "Content-Type: application/json" -d '
#### data insertion
The data can for example be found at: [](
use the csv2e-script to add data to the new index
in `/csv2es/`
in `csv2es/`
npm install &&
./csv2es.js family2coords_1996.csv 1996 &&
./csv2es.js family2coords_1890.csv 1890
You need to check wether you already inserted the data. Alternatively you can use `init.js`
Alternatively you can use `init.js`.
It assumes there are two files in `csv2es/` called:
`familyname2coordinate_1890.csv.gz` and `familyname2coordinate_1996.csv.gz`
### server and client
#### Start server
in `/server/`
in `server/`
npm install && npm start
......@@ -54,4 +58,7 @@ or in `/client`
npm run build
builds app, build in `/client/dist/`
\ No newline at end of file
builds app, build in `/client/dist/`
# Problems
The insertion process of feeding the data into Elasticsearch is machine dependent. This means that there are possibilities of request timeouts on slow machines for example. If this happens to you, you need to change some of the specifics of the insertion in `csv2es/csv2es.js`.
\ No newline at end of file
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment