aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..14abca3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+GraphGraph is a tool for viewing A&AI schemas.
+
+## Running frontend and backend separately (development)
+
+To start the frontend just run the following command:
+
+### `cd ./graphgraph-fe && npm run build`
+
+Then go to http://localhost:3000
+
+In order to start the webservices run the App.java from your Java IDE (the service runs on localhost port 8080).
+
+## Running from command line
+
+To run GraphGraph from the command line just run the shell script:
+
+### `./run.sh`
+
+## Creating a standalone jar
+
+To create a standalone Java jar file run the build script:
+
+### `./buildjar.sh`
+
+Afterwards you can start GraphGraph just by running the command:
+
+### `java -jar ./target/graphgraph-1.0-SNAPSHOT.jar`