data-quality-dashboard

The Data Quality Dashboard VSCode extension simplifies quality checks for a security knowledge graph developed by Software Competence Center Hagenberg GmbH in collaboration with Limes Security GmbH. With a single command, the extension launches a Docker-based graph database, performs quality evaluations (completeness, consistency, schema readability), and starts a Node.js server to display results in an interactive React dashboard.

Table of Contents

• Prerequisites
• Running the Extension
  • Running in Development Mode
  • VSIX Installation
• Usage
• Additional Information
• License

Prerequisites

• VSCode: Download and install Visual Studio Code and open the project in it.
• Python 3: Download and install Python 3.
• Node.js (v16 or higher): Download and install Node.js (version 16 or newer).
• Docker: Download and install Docker, then ensure Docker is running.
• VSCode Python Extension: Install the Python extension for VSCode.
• Python Libraries: Run pip install -r requirements.txt in the terminal to install necessary libraries.
• Node.js Libraries: Run npm install in the terminal to install all required Node.js dependencies(this is only necessary if you want to run the extension in development mode).

Running the Extension

Running in Development Mode

To run the extension in development mode, use the pre-configured launch settings in the .vscode/launch.json file.

1. Open the debug pane in VSCode.
2. Select Server + Client from the run/debug configuration dropdown.
3. Click the green play button to launch both the server and client concurrently.

This will start the necessary components of the extension, and a new VSCode window will open where you can utilize and test the extension in real-time.

VSIX Installation(Not Supported Yet)

To install the extension via a VSIX file, follow these steps:

1. Open the Command Prompt (or terminal) in the directory of this extension project.

2. Execute the following command:

   code --install-extension <path/to/vsix.file>

Usage

To run the process, open the Command Palette in VSCode (press Ctrl+Shift+P or Cmd+Shift+P on macOS) and search for the command:

• DQ Dashboard: Start

Additional Information

For detailed instructions on Docker image creation and how the export is performed, please refer to the README.md located in the semanticLib/resources/kg/ directory.

License

This project is licensed under the Apache License 2.0. You may not use this project except in compliance with the License. You can view the full text of the license at the following link:

Apache License 2.0