Add example for the analysis of a Typescript project.

Author: JohT

COMMANDS.md

@@ -22,7 +22,7 @@
     - [Setup Neo4j Graph Database](#setup-neo4j-graph-database)
     - [Start Neo4j Graph Database](#start-neo4j-graph-database)
     - [Setup jQAssistant Java Code Analyzer](#setup-jqassistant-java-code-analyzer)
-    - [Download Maven Artifacts to Analyze](#download-maven-artifacts-to-analyze)
+    - [Download Maven Artifacts to analyze](#download-maven-artifacts-to-analyze)
     - [Reset the database and scan the java artifacts](#reset-the-database-and-scan-the-java-artifacts)
 - [Database Queries](#database-queries)
     - [Cypher Shell](#cypher-shell)
@@ -52,7 +52,8 @@ To run all analysis steps simple execute the following command:
 ./../../scripts/analysis/analyze.sh
 ```
 
-👉 See [scripts/examples/analyzeAxonFramework.sh](./scripts/examples/analyzeAxonFramework.sh) as an example script that combines all the above steps.  
+👉 See [scripts/examples/analyzeAxonFramework.sh](./scripts/examples/analyzeAxonFramework.sh) as an example script that combines all the above steps for a Java Project.
+👉 See [scripts/examples/analyzeReactRouter.sh](./scripts/examples/analyzeReactRouter.sh) as an example script that combines all the above steps for a Typescript Project.  
 👉 See [Code Structure Analysis Pipeline](./.github/workflows/java-code-analysis.yml) on how to do this within a GitHub Actions Workflow.
 
 ### Command Line Options

GETTING_STARTED.md

@@ -80,5 +80,6 @@ Please read through the [Prerequisites](./README.md#hammer_and_wrench-prerequisi
 
     Then open your browser and login to your [local Neo4j Web UI](http://localhost:7474/browser) with "neo4j" as user and the initial password you've chosen.
 
-👉 See [scripts/examples/analyzeAxonFramework.sh](./scripts/examples/analyzeAxonFramework.sh) as an example script that combines all the above steps.  
+👉 See [scripts/examples/analyzeAxonFramework.sh](./scripts/examples/analyzeAxonFramework.sh) as an example script that combines all the above steps for a Java Project.
+👉 See [scripts/examples/analyzeReactRouter.sh](./scripts/examples/analyzeReactRouter.sh) as an example script that combines all the above steps for a Typescript Project. 
 👉 See [Code Structure Analysis Pipeline](./.github/workflows/java-code-analysis.yml) on how to do this within a GitHub Actions Workflow.

scripts/examples/analyzeReactRouter.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+# This is an example for the analysis of a the Typescript project "react-router".
+# It includes the creation of the temporary directory, the working directory, the artifacts download and the analysis itself.
+
+# Note: The first (and only) parameter is the version of "react-router" to analyze.
+# Note: This script is meant to be started in the root directory of this repository.
+
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -o errexit -o pipefail
+
+# Read the first input argument containing the version of the artifacts
+if [ "$#" -ne 1 ]; then
+  echo "analyzerReactRouter Error: Usage: $0 <version>" >&2
+  exit 1
+fi
+projectVersion=$1
+
+# Check if environment variable is set
+if [ -z "${NEO4J_INITIAL_PASSWORD}" ]; then
+    echo "analyzerReactRouter: Error: Requires environment variable NEO4J_INITIAL_PASSWORD to be set first. Use 'export NEO4J_INITIAL_PASSWORD=<your-own-password>'."
+    exit 1
+fi
+
+# Create the temporary directory for all analysis projects.
+mkdir -p ./temp
+cd ./temp
+
+# Create the working directory for this specific analysis.
+mkdir -p "./react-router-${projectVersion}"
+cd "./react-router-${projectVersion}" 
+
+# Create the artifacts directory that will contain the code to be analyzed.
+mkdir -p ./artifacts
+
+# Download AxonFramework artifacts (jar files) from Maven
+./../../scripts/downloader/downloadReactRouter.sh "${projectVersion}"
+
+# Start the analysis
+./../../scripts/analysis/analyze.sh