A web interface to build custom queries for the Knowledge Store and generate datafiles that can be visualized with the Storyteller interface.
The QueryBuilder client is made using the https://facebook.github.io/react/ framework and uses http://redux.js.org/ for state management. It is written in Typescript. While this repository is in principle standalone and will operate, it is recommended to be used with the entire software stack, as detailed below.
Please note that the smooth operation of this module is dependent on a running nlescstoryteller/query-builder-server running on port http://localhost:5000/ and makes heavy use of the API provided here:https://github.com/NLeSC-Storyteller/query-builder-server/blob/master/doc/API.md.
Please note that the installation and execution process is usually fully automated by Docker and Docker-Compose. For information on installing the full stack, see the https://github.com/cltl/StoryTeller repository for more information.
With Docker
A Dockerfile has been provided for your convenience. Please refer to https://www.docker.com/ for installation of docker.
docker build -t nlescstoryteller/query-builder-client
With Node Package Manager
The requirements for this single repository are easily installed using the node package manager http://nodejs.org/.
After the installation of node package manager, the following bash command may be used to install the system:
npm install
Please note that the installation and execution process is usually fully automated by Docker and Docker-Compose. For information on installing the full stack, see the https://github.com/NLeSC-Storyteller/StoryTeller repository for more information.
With Docker
docker run nlescstoryteller/query-builder-client
With Node Package Manager
npm start
The user is expected to find the QueryBuilder client interface at http://localhost:3000/
The user may encounter an interface with one or more empty lists under the list categories. This is probably due to a malfunction in the preprocessing steps. Please see https://github.com/NLeSC-Storyteller/query-builder-preprocessing/blob/master/README.md#troubleshooting for tips on how to resolve these issues.
linux
sudo docker exec -v data:/data -it nlescstoryteller/query-builder-client /bin/bash
windows
winpty docker exec -v data:/data -ti nlescstoryteller/query-builder-client //bin/bash
The full system consists of 7 parts: