diff --git a/README.md b/README.md index bd299cd6a4c8a53897cf5eac547415421f72607f..f561800f4008a482345e750e66e17772db09ff99 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,21 @@ data quickly, leaving more time for coding and other activities. ## -## installation -Application runs in the web on a browser, so no other tools are needed. (The -is meant for desktop computers, and will not scale for tablets, phones, or -other devices). +## Installation +This application is the backend of the Common Query Engine and Viewer application that runs in the background without any form for graphical user interface. +### Packaging +Run "mvn clean package" in the terminal to create a .jar file that can be executed using a JDK. +### Building docker image +Run "docker build -t query_engine ." in the terminal to build the docker image. - +### Starting the docker container +To be able to start the docker container run "docker run --name "spring" -d -p 8080:8080" in the terminal. + + +### Important note! +* The Dockerfile must be in the same folder as the jar. +* The backend is set up to use port 8080. +* To open the GraphQL terminal, go to "$URL:8080/graphiql". Please note that $URL must be replaced with the ip address of the server running the image. +* By running GraphQL queries towards "http://$URL:8080/graphql" you are able to fetch data. Please note that $URL must be replaced with the ip address of the server running the image. \ No newline at end of file