From 77fc7c378a28fdaadff5e6fc63b3aa2e7cb59c76 Mon Sep 17 00:00:00 2001 From: jrtechs Date: Sat, 14 Jul 2018 16:11:12 -0400 Subject: [PATCH] Updated docs to include how to run the project and added a bash script to build the jar file. --- README.md | 12 ++++++++++++ buildJar.sh | 8 ++++++++ 2 files changed, 20 insertions(+) create mode 100755 buildJar.sh diff --git a/README.md b/README.md index 1592fd4..6a3697d 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,18 @@ chance at any time that you will be able to access it. ![Graph](website/img/jrtechs2.png) +## Running this Project +* First you need to obtain a steam api key from [https://steamcommunity.com/dev/apikey](steam's website). +* Place the api key in the SteamAPIKey.json file under the conf/ folder. +* Spin up a local gremlin server to connect to. +* Install and configure Maven if you don't already have it installed. +* Run the App.java class either in a java IDE which supports maven (for dependencies), or build this +project into a jar and run it. I have a buildJar.sh which builds a jar file to use -- please note that +you still need to have maven installed. There is also a run.sh file which will run the jar file once +you place it in the same directory as the run script. +* Open graphs.html under the website/ folder in your web browser. + + # TODO * Include a steam name to steam id lookup * Dockerize this entire environment diff --git a/buildJar.sh b/buildJar.sh new file mode 100755 index 0000000..13c2014 --- /dev/null +++ b/buildJar.sh @@ -0,0 +1,8 @@ +#!/bin/bash + +# Builds a jar file and places it in the target folder. +# For this to work, you need to have maven installed. +# +# 7/14/18 Jeffery Russell + +mvn clean compile assembly:single \ No newline at end of file