Skip to main content

Getting Started with PIQUE Lite

Welcome to PIQUE Lite! This guide will walk you through installing, setting up, and running the tool on your machine. Currently, we are also working on exporting this dashboard to an website, by which users can access the tool via the web URL, currently this link will direct you to a placeholder if you prefer to bypass the following command line installation. The placeholder will be updated after December 15th, 2025.

The following of this section will provide a guidance regarding setting up te tool with the GitHub repository.

Prerequisites​

Ensure you have the following installed:

  • Node.js (16.x or later) – Required to run PIQUE Lite. Check your version with: 
    node --version
  • bun – Comes with Node.js, used for managing dependencies. Install bun. following the guidance provided in its official website, check with: 
    bun --version
  • Git – Needed to clone the repository.
  • Python 3.8+ – Required for building documentation. Check with: 
    python --version
  • (Optional) Virtual Environment – Useful for managing dependencies separately.

Installation​

Follow these steps to install the application:

Clone the Repository​

Clone the repository to your local machine using Git:

git clone https://github.com/MSUSEL/Pique-Lite.git
cd Pique-Lite

(Optional) Set up a Virtual Environment​

# Example using `venv` on Linux:
python3 -m venv venv
source venv/bin/activate

Install Dependencies​

First ensure bun is installed successfully.

Then install PIQUE dependencies:

bun install

Install documentation dependencies:

pip install -r requirements.txt

If using pyproject.toml, install with:

pip install .

Run the Tool​

Once installed, start the tool:

bun run dev

Open your browser and go to:

http://localhost:4680

Note: The port shown above is the default development port. It may differ on your machine if that port is already in use.

Next Steps​

Now that the PIQUE Lite is running, you can analyze your software quality results!

  • Explore the User Guide for a detailed walkthrough.
  • Refer to the Input Schema to prepare your JSON input files.