Browse Source

Updated docs to include how to run the project and added a bash script to build the jar file.

pull/8/head
jrtechs 6 years ago
parent
commit
77fc7c378a
2 changed files with 20 additions and 0 deletions
  1. +12
    -0
      README.md
  2. +8
    -0
      buildJar.sh

+ 12
- 0
README.md View File

@ -19,6 +19,18 @@ chance at any time that you will be able to access it.
![Graph](website/img/jrtechs2.png) ![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 # TODO
* Include a steam name to steam id lookup * Include a steam name to steam id lookup
* Dockerize this entire environment * Dockerize this entire environment

+ 8
- 0
buildJar.sh View File

@ -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

Loading…
Cancel
Save