User Guide

System Requirements

Java 8+ for building and at runtime.

Git 2+ and Gradle 7+ to obtain and build the source code.

How to download the Quickstart

Go to https://github.com/larrydiamond/sqgraph/releases to the latest release and download the QUICKSTART zip file and copy the contents into an empty directory.

(and now you can skip downloading the source code and building and go right to "How to get running quickly")

How to download the source code

git clone https://github.com/larrydiamond/sqgraph.git

How to build

cd sqgraph
gradlew clean build
copy build\libs\sqgraph-x.y.z-SNAPSHOT.jar .

How to get running quickly (using SonarCloud)

Make an account on SonarCloud.io

Make a user token for your SonarCloud account as per User Tokens

set SONARLOGIN=your new user token from SonarCloud
java -jar sqgraph-x.y.z-SNAPSHOT.jar sonarcloud.json

There will be some new .PNG files in the current directory - congratulations you've done it!

How to get running using your organization's SonarQube server (almost as quickly)

Make a user token for your SonarQube instance User Tokens

set SONARLOGIN=your new user token from your organization's SonarQube server

Bring up sample.json in the text editor of your choice

Change the url value to the URL of your SonarQube server

Change the application titles and keys to the titles and keys of your applications

save your modified sample.json file

Now execute the following:

java -jar sqgraph-x.y.z-SNAPSHOT.jar sample.json

There will be some new .PNG files and a .PDF file in the current directory - congratulations you've done it!